接口功能介绍

创建自定义域名

接口约束

无

URI

POST /openapi/v1/domains/customdomains

路径参数
无

Query参数
无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池id	test

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
authConfig	是	Object	认证配置信息		AuthConfig
certConfig	否	Object	HTTPS证书的信息		CERTConfig
description	否	String	自定义描述	-	-
domainName	是	String	自定义域名名称（已备案或接入备案）	example.com	-
protocol	是	String	域名支持的协议类型：HTTP, HTTPS, HTTP,HTTPS	HTTPS	-
routeConfig	否	Object	自定义域名访问时的PATH到Function映射		RouteConfig

表 AuthConfig

参数	是否必填	参数类型	说明	示例	下级对象
authType	是	String	认证类型：anonymous｜jwt	jwt	-
jwtConfig	否	Object	jwt 认证配置		JwtConfig

表 JwtConfig

参数	是否必填	参数类型	说明	示例	下级对象
claimTrans	是	Array of Objects	JWT 的 claim 映射到请求的某个位置		ClaimTran
jwks	是	String	包含一个或多个 JWK 的 JSON 字符串	-	-
tokenConfig	是	Array of Objects	token 解析的相关配置		TokenConfig

表 ClaimTran

参数	是否必填	参数类型	说明	示例	下级对象
claimName	是	String	要进行映射的 claim 字段	user	-
targetName	是	String	映射后的字段名	username	-
transLocation	是	String	映射到请求的位置：Header	Header	-

表 TokenConfig

参数	是否必填	参数类型	说明	示例	下级对象
location	是	String	token 读取的位置：Cookie, Header, Query	Header	-
name	是	String	token 在读取位置对应的字段名	Authorization	-
removePrefix	否	String	token 需要去除的前缀（仅读取位置为 Header 时使用）	Bearer	-

表 CERTConfig

参数	是否必填	参数类型	说明	示例	下级对象
certificate	是	String	HTTPS证书内容	-	-
certName	是	String	证书的名称	my-cert	-
privateKey	是	String	证书私钥内容	-	-

表 RouteConfig

参数	是否必填	参数类型	说明	示例	下级对象
routes	否	Array of Objects	路由规则列表		PathConfig

表 PathConfig

参数	是否必填	参数类型	说明	示例	下级对象
enableJwt	是	Integer	是否开启 JWT 认证：0：不开；1:开启	1	-
functionId	是	Integer	路由规则对应的函数 ID	12345	-
functionName	是	String	路由规则对应的函数名称	my-function	-
functionUniqueName	是	String	函数的唯一名称	my-function-unique	-
path	是	String	路由规则对应的请求路径	/api/path, 支持后缀统配符*，例如/api/*	-
qualifier	否	String	路由规则对应的函数版本或别名或LATEST	1 or prod or LATEAT	-

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	状态码,0表示成功，非0表示不成功	0
code	String	错误码	CF_0
message	String	信息
returnObj	Object	返回实体		ReturnObj

表 表 ReturnObj

参数	参数类型	说明	示例	下级对象
createdAt	String	创建时间	2024-10-08T15:35:41.427170734+08:00
updatedAt	String	更新时间	2024-10-08T15:35:41.623015323+08:00
creator	Integer	创建者ID	17250
editor	Integer	编辑者ID	17250
certConfig	Object	HTTPS证书信息		CERTConfig
domainName	String	自定义域名	example.com
protocol	String	协议类型	HTTP
routeConfig	Object	路由表		RouteConfig
authConfig	Object	认证配置		AuthConfig
domainStatus	String	域名备案状态	0
filingStatus	Object	域名备案详细信息		FilingStatus
description	String	描述
cnameValid	Boolean	CNAME是否有效，仅在应用场景下有意义	false

表 CERTConfig

参数	参数类型	说明	示例	下级对象
certificate	String	证书
certName	String	证书名称
privateKey	String	私钥

表 RouteConfig

参数	参数类型	说明	示例	下级对象
routes	Array of Objects	路由映射		PathConfig

表 PathConfig

参数	参数类型	说明	示例	下级对象
enableJwt	Integer	是否启用JWT	0
functionId	Integer	函数ID	2807999806632073
functionName	String	函数名称	ccc
functionUniqueName	String	函数唯一名称	ccc-sykqwhnjwu
path	String	请求路径	/*
qualifier	String	函数版本	2

表 AuthConfig

参数	参数类型	说明	示例	下级对象
authType	String	认证类型	anonymous
jwtConfig	Object	JWT配置		JwtConfig

表 JwtConfig

参数	参数类型	说明	示例	下级对象
jwks	String	JWK字符串
tokenConfig	Array of Objects	Token配置		TokenConfig
matchMode	Object	JWT匹配模式，固定为All		MatchMode

表 TokenConfig

参数	参数类型	说明	示例	下级对象
location	String	Token读取位置
name	String	字段名

表 MatchMode

参数	参数类型	说明	示例	下级对象
mode	String	匹配模式	All
path	Array of Strings	匹配路径	[]

表 FilingStatus

参数	参数类型	说明	示例	下级对象
domain	String	一级域名	example.com
recordStatus	String	备案状态,0：未备案 1：已备案	0
recordNumber	String	备案号	-
errMessage	String	异常信息

枚举参数

无

请求示例

请求url

https://{host}/openapi/v1/domains/customdomains

请求头header

无

请求体body

{
    "domainName": "test.mzychaco.email",
    "protocol": "HTTP",
    "routeConfig": {
        "routes": [
            {
            "functionName": "oom-test",
            "path": "/oom/lasest",
            "qualifier": "LATEST"
            }
        ]
    },
    "certConfig": {
        "certName": "",
        "certificate": "",
        "privateKey": ""
    },
    "authConfig": {
        "authType": "anonymous"
    }
}

响应示例

{
    "statusCode": 0,
    "code": "CF_0",
    "message": "",
    "returnObj": {
        "createdAt": "2024-10-08T19:59:25.869382+08:00",
        "updatedAt": "2024-10-08T19:59:26.792778+08:00",
        "creator": 82647,
        "editor": 82647,
        "certConfig": {
            "certificate": "",
            "certName": "",
            "privateKey": ""
        },
        "domainName": "test.mzychaco.email",
        "protocol": "HTTP",
        "routeConfig": {
            "routes": [
                {
                    "functionName": "oom-test",
                    "functionUniqueName": "oom-test-yppopcjasv",
                    "functionId": 266,
                    "path": "/oom/lasest",
                    "qualifier": "LATEST",
                    "rewriteConfig": {
                        "regexRules": null,
                        "wildcardRules": null
                    },
                    "enableJwt": 0
                }
            ]
        },
        "authConfig": {
            "authType": "anonymous"
        },
        "domainStatus": "",
        "filingStatus": {
            "domain": "",
            "recordStatus": "",
            "recordNumber": "",
            "errMessage": "domain check is close"
        },
        "description": "",
        "cnameValid": false
    }
}

状态码

请参考 状态码

错误码

请参考 错误码