API 网关
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 网关 > API 文档 > 自定义域名相关接口 > 服务绑定自定义域名

服务绑定自定义域名

最近更新时间：2024-03-12 01:08:34

我的收藏

本页目录：

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：BindSubDomain。
Version 是 String 公共参数，本接口取值：2018-08-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
ServiceId 是 String 服务唯一 ID。
示例值：service-1w9ekbwo
SubDomain 是 String 待绑定的自定义的域名。
示例值：xxx.com
Protocol 是 String 服务支持协议，可选值为http、https、http&https。
示例值：http
NetType 是 String 网络类型，可选值为OUTER、INNER。
示例值：OUTER
IsDefaultMapping 是 Boolean 是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 PathMappingSet 必填。
示例值：TRUE
NetSubDomain 是 String 默认域名。
示例值：service-1w9ekbwo-1259027407.gz.apigw.tencentcs.com
CertificateId 否 String 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。
示例值：x x
PathMappingSet.N 否 Array of PathMapping 自定义域名路径映射，最多输入三个Environment，并且只能分别取值“test”、 ”prepub“、”release“。
IsForcedHttps 否 Boolean 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
示例值：TRUE

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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.0.Environment=release
&PathMappingSet.0.Path=/
&Protocol=http
&IsForcedHttps=TRUE
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CertificateIdEnterpriseWaitSubmit 该证书为企业证书，待提交。
FailedOperation.CertificateIdError 证书不存在或者您没有权限查看，请在ssl证书管理平台上传有效证书。
FailedOperation.CertificateIdExpired 证书已过期，请上传其他有效证书。
FailedOperation.CertificateIdInfoError 该证书信息内容为空，请联系证书同事。
FailedOperation.CertificateIdUnderVerify 该证书处于审核中状态，请上传其他有效证书。
FailedOperation.CertificateIdUnknownError 证书处于未知状态，请联系证书同事查看具体状态。
FailedOperation.CertificateIdVerifyFail 证书处于审核失败状态，请上传其他有效证书。
FailedOperation.CertificateIsNull Apis 证书为空，请上传证书。
FailedOperation.DefineMappingEnvironmentError Apis 环境配置错误。
FailedOperation.DefineMappingNotNull Apis自定义路径映射不能为空。
FailedOperation.DefineMappingParamRepeat Apis 参数重复。
FailedOperation.DefineMappingPathError Apis自定义路径配置错误。
FailedOperation.DomainAlreadyBindOtherService 该域名已经绑定其他服务。
FailedOperation.DomainAlreadyBindService 该域名已经绑定该服务。
FailedOperation.DomainInBlackList 当前域名不满足合规要求，无法进行接入。
FailedOperation.DomainNeedBeian 该域名还未在腾讯云备案，请备案之后再绑定域名。
FailedOperation.DomainResolveError 该域名未配置cname到默认域名，或者解析未生效。
FailedOperation.FormatError 域名格式错误。
FailedOperation.IsDefaultMapping Apis 自定义路径与默认路径冲突。
FailedOperation.NetSubDomainError 默认的二级域名输入错误。
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
FailedOperation.SubDomainFormatError 自定义域名格式错误。
InternalError 内部错误。
InternalError.ApigwException API网关内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InternalError.OssException oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.InvalidProcotol 无效的协议类型参数。
LimitExceeded.ExceededDefineMappingLimit 自定义路径映射，最多三组。
LimitExceeded.ExceededDomainLimit 绑定域名数量超出限制，默认最多5个。
LimitExceeded.RequestLimitExceeded 请求频率超限制，请稍等再试。
ResourceNotFound.InvalidService 对应服务不可见。
UnsupportedOperation.ForceHttps 协议为HTTP时，不支持强制Https。
UnsupportedOperation.InvalidServiceTrade 当前服务处于隔离中，暂不支持此操作。
中国站