API 文档

服务绑定自定义域名

最近更新时间:2020-09-02 08:20:17

1. 接口描述

接口请求域名: apigateway.tencentcloudapi.com 。

本接口(BindSubDomain)用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用,但当用户想使用自己的已有域名时,也可以将自定义域名绑定到此服务,在做好备案、与默认域名的 CNAME 后,可直接调用自定义域名。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:apigateway.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindSubDomain。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
ServiceId String 服务唯一 ID。
SubDomain String 待绑定的自定义的域名。
Protocol String 服务支持协议,可选值为http、https、http&https。
NetType String 网络类型,可选值为OUTER、INNER。
IsDefaultMapping Boolean 是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。
NetSubDomain String 默认域名。
CertificateId String 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。
PathMappingSet.N Array of PathMapping 自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定自定义域名

输入示例

https://apigateway.tencentcloudapi.com/?Action=BindSubDomain
&ServiceId=service-1w9ekbwo
&NetType=OUTER
&SubDomain=xxx.com
&NetSubDomain=service-1w9ekbwo-1259027407.gz.apigw.tencentcs.com
&IsDefaultMapping=TRUE
&PathMappingSet=[]
&Protocol=http
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": true,
    "RequestId": "6e00553a-8158-4f70-ad43-e1b046af1502"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CertificateIdEnterpriseWaitSubmit 企业证书,待提交。
FailedOperation.CertificateIdError 证书不存在或者您没有权限查看,请在ssl证书管理平台上传有效证书。
FailedOperation.CertificateIdExpired 证书已过期。
FailedOperation.CertificateIdInfoError 该证书信息内容为空,请联系证书同事。
FailedOperation.CertificateIdUnderVerify 证书还在审核中。
FailedOperation.CertificateIdUnknownError 证书其他未知状态,请联系证书同事。
FailedOperation.CertificateIdVerifyFail 证书审核失败。
FailedOperation.CertificateIsNull 证书Id为空。
FailedOperation.DefineMappingEnvironmentError 自定义路径映射,Environment只能取值'test'、 'prepub', 'release'。
FailedOperation.DefineMappingNotNull 选择自定义路径映射时,不能为空。
FailedOperation.DefineMappingParamRepeat 自定义路径映射,取值重复。
FailedOperation.DefineMappingPathError 自定义路径映射,Path不符规范。
FailedOperation.DomainAlreadyBindOtherService 该域名已经绑定其他服务。
FailedOperation.DomainAlreadyBindService 该域名已经绑定该服务。
FailedOperation.DomainNeedBeian 该域名还未在腾讯云备案,请备案之后再绑定域名。
FailedOperation.DomainResolveError 该自定义域名没有配置CNAME到默认域名,或者还未生效。
FailedOperation.FormatError 域名格式错误。
FailedOperation.IsDefaultMapping 使用默认路径映射时,不能输入PathMappingSet。
FailedOperation.NetSubDomainError 默认的二级域名输入错误。
FailedOperation.ServiceError 服务相关的错误。
InternalError 内部错误。
InternalError.OssException oss内部错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.InvalidProcotol 无效的协议类型参数。
LimitExceeded.ExceededDefineMappingLimit 自定义路径映射,最多三组。
LimitExceeded.ExceededDomainLimit 绑定域名数量超出限制,默认最多5个。
ResourceNotFound.InvalidService 对应服务不可见。
UnsupportedOperation.InvalidServiceTrade 当前服务处于隔离中,暂不支持此操作。
目录