服务修改自定义域名

最近更新时间: 2024-10-18 10:38:33

1. 接口描述

接口请求域名: apigateway.api3.fincloud.tencent.cn。

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

默认接口请求频率限制:20次/秒。

接口更新时间:2021-08-02 19:48:45。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:ModifySubDomain
Version String 公共参数,本接口取值:2018-08-08
Region String 公共参数,详见产品支持的地域列表(TODO)
ServiceId String 服务唯一 ID。
SubDomain String 待修改路径映射的自定义的域名。
CertificateId String 证书 ID,协议包含 HTTPS 的时候要传该字段。
IsDefaultMapping Bool 是否修改为使用默认路径映射。为 true,表示使用默认路径映射,为 false,表示使用自定义路径映射。
Protocol String 修改后的自定义域名协议类型。(http,https 或 http&https)
PathMappingSet Array of PathMapping 修改后的路径映射列表。
NetType String 网络类型 ('INNER' 或 'OUTER')
IsForcedHttps Bool 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。

3. 输出参数

参数名称 类型 描述
Result Bool 修改自定义域名操作是否成功。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameter.FormatError
FailedOperation.CertificateIdError
UnsupportedOperation.InvalidServiceTrade
FailedOperation.ServiceNotExist
FailedOperation.ServiceError
FailedOperation.SubDomainFormatError
FailedOperation.SetCustomPathMappingError
FailedOperation.PathMappingSetError
FailedOperation.CertificateIdBindError
FailedOperation.UnknownProtocolTypeError
InternalError.OssException
UnsupportedOperation.ForceHttps
FailedOperation.ServiceInOperation