服务修改自定义域名

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

接口描述

本接口(ModifySubDomain)用于修改服务的自定义域名设置中的路径映射,可以修改绑定自定义域名之前的路径映射规则。

输入参数

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

参数名称 是否必选 类型 描述
serviceId String 服务唯一 ID。
subDomain String 待修改路径映射的自定义的域名。
isDefaultMapping String 是否修改为使用默认路径映射。为 TRUE,表示使用默认路径映射,为 FALSE,表示使用自定义路径映射。
pathMappingSet.n.path Object 修改后的自定义路径映射的路径。
pathMappingSet.n.environment Object 修改后的自定义路径映射的环境名称。
protocol String 修改后的自定义域名协议类型。
certificateId String 证书 ID,协议包含 HTTPS 的时候要传该字段。

输出参数

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

示例

输入示例:

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

输出示例:

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