ModifySubDomain
最近更新时间: 2025-10-20 17:06:00
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 | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| 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 | 证书不存在或者您没有权限查看，请在ssl证书管理平台上传有效证书。 |
| UnsupportedOperation.InvalidServiceTrade | 当前服务处于隔离中，暂不支持此操作。 |
| FailedOperation.ServiceNotExist | 服务不存在。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.SubDomainFormatError | 自定义域名格式错误。 |
| FailedOperation.SetCustomPathMappingError | 自定义域名已使用默认路径映射，不支持设置自定义路径。 |
| FailedOperation.PathMappingSetError | 设置路径映射错误。 |
| FailedOperation.CertificateIdBindError | 证书绑定错误。 |
| FailedOperation.UnknownProtocolTypeError | 协议类型错误。 |
| InternalError.OssException | oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| UnsupportedOperation.ForceHttps | 协议为HTTP时，不支持强制Https。 |
| FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |