BindSubDomain
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（BindSubDomain）用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用，但当用户想使用自己的已有域名时，也可以将自定义域名绑定到此服务，在做好备案、与默认域名的 CNAME 后，可直接调用自定义域名。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-08-19 14:02:40。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：BindSubDomain |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ServiceId | 是 | 否 | String | 服务唯一 ID。 |
| SubDomain | 是 | 否 | String | 待绑定的自定义的域名。 |
| Protocol | 是 | 否 | String | 服务支持协议，可选值为http、https、http&https。 |
| NetType | 是 | 否 | String | 网络类型，可选值为OUTER、INNER。 |
| IsDefaultMapping | 是 | 否 | Bool | 是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 PathMappingSet 必填。 |
| NetSubDomain | 是 | 否 | String | 默认域名。 |
| CertificateId | 否 | 否 | String | 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。 |
| PathMappingSet | 否 | 否 | Array of PathMapping | 自定义域名路径映射，最多输入三个Environment，并且只能分别取值“test”、 ”prepub“、”release“。 |
| IsForcedHttps | 否 | 否 | Bool | 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 绑定操作是否成功。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.InvalidService | 对应服务不可见。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| FailedOperation.DefineMappingNotNull | Apis自定义路径映射不能为空。 |
| LimitExceeded.ExceededDefineMappingLimit | 自定义路径映射，最多三组。 |
| FailedOperation.DefineMappingPathError | Apis自定义路径配置错误。 |
| FailedOperation.DefineMappingEnvironmentError | Apis 环境配置错误。 |
| FailedOperation.DefineMappingParamRepeat | Apis 参数重复。 |
| FailedOperation.NetSubDomainError | 默认的二级域名输入错误。 |
| LimitExceeded.ExceededDomainLimit | 绑定域名数量超出限制，默认最多5个。 |
| FailedOperation.DomainAlreadyBindService | 该域名已经绑定该服务。 |
| FailedOperation.IsDefaultMapping | Apis 自定义路径与默认路径冲突。 |
| FailedOperation.CertificateIsNull | Apis 证书为空，请上传证书。 |
| FailedOperation.CertificateIdError | 证书不存在或者您没有权限查看，请在ssl证书管理平台上传有效证书。 |
| FailedOperation.CertificateIdUnderVerify | 该证书处于审核中状态，请上传其他有效证书。 |
| FailedOperation.CertificateIdVerifyFail | 证书处于审核失败状态，请上传其他有效证书。 |
| FailedOperation.CertificateIdExpired | 证书已过期，请上传其他有效证书。 |
| FailedOperation.CertificateIdEnterpriseWaitSubmit | 该证书为企业证书，待提交。 |
| FailedOperation.CertificateIdInfoError | 该证书信息内容为空，请联系证书同事。 |
| InternalError | 内部错误。 |
| FailedOperation.CertificateIdUnknownError | 证书处于未知状态，请联系证书同事查看具体状态。 |
| InvalidParameterValue.InvalidProcotol | 无效的协议类型参数。 |
| FailedOperation.FormatError | 域名格式错误。 |
| FailedOperation.DomainResolveError | 该域名未配置cname到默认域名，或者解析未生效。 |
| FailedOperation.DomainNeedBeian | 该域名还未备案，请备案之后再绑定域名。 |
| FailedOperation.DomainAlreadyBindOtherService | 该域名已经绑定其他服务。 |
| UnsupportedOperation.InvalidServiceTrade | 当前服务处于隔离中，暂不支持此操作。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.SubDomainFormatError | 自定义域名格式错误。 |
| InternalError.OssException | oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.ApigwException | API网关内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| UnsupportedOperation.ForceHttps | 协议为HTTP时，不支持强制Https。 |
| LimitExceeded.RequestLimitExceeded | 请求频率超限制，请稍等再试。 |
| FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |
| FailedOperation.DomainInBlackList | 当前域名不满足合规要求，无法进行接入。 |