服务绑定自定义域名

最近更新时间:2019-04-26 15:19:36

接口描述

本接口(BindSubDomain)用于绑定自定义域名到服务。
API 网关中每个服务都会提供一个默认的域名供用户调用,但当用户想使用自己的已有域名时,也可以将自定义域名绑定到此服务,在做好与默认域名的 CNAME 后,可直接调用自定义域名。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
serviceId String 服务唯一 ID。
subDomain String 待绑定的自定义的域名。
certificateId String 待绑定自定义域名的证书唯一 ID。
isDefaultMapping String 是否使用默认路径映射,默认为 TRUE。为 FALSE 时,表示自定义路径映射,此时 pathMappingSet 必填。
pathMappingSet.n.path Object 自定义路径映射的路径。使用自定义映射时,可一次仅映射一个 path 到一个环境,也可映射多个 path 到多个环境。并且一旦使用自定义映射,原本的默认映射规则不再生效,只有自定义映射路径生效。
pathMappingSet.n.environment Object 自定义路径映射的环境名称。
protocol String 绑定自定义域名的协议类型,默认与服务的前端协议一致。

输出参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因 。
message String 模块错误信息描述,与接口相关。

示例

输入示例:

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=BindSubDomain
&serviceId=service-XXXX
&subDomain=testSubDomain
&certificate=testcertificate
&pathMapping.0.path=/test
&pathMapping.0.environment=release

输出示例:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success"
}