删除自定义域名的路径映射
最近更新时间: 2024-06-18 14:31:34
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（DeleteServiceSubDomainMapping）用于删除服务中某个环境的自定义域名映射。 当用户使用自定义域名，并使用了自定义映射时，可使用此接口。但需注意，若删除了所有环境的映射时，调用此 API 均会返回失败。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-06-24 15:24:06。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DeleteServiceSubDomainMapping |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| ServiceId | 是 | 否 | String | 服务唯一 ID。 |
| SubDomain | 是 | 否 | String | 服务绑定的自定义域名。 |
| Environment | 是 | 否 | String | 待删除映射的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 删除自定义域名的路径映射操作是否成功。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| UnsupportedOperation.InvalidServiceTrade | |
| FailedOperation.ServiceNotExist | |
| FailedOperation.DeletePathMappingSetError |