文档中心 全球应用加速 API 文档 规则相关接口 创建HTTPS监听器的访问域名

创建HTTPS监听器的访问域名

最近更新时间:2019-08-09 19:18:43

1. 接口描述

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

本接口(CreateDomain)用于创建HTTP/HTTPS监听器的访问域名,客户端请求通过访问该域名来请求后端业务。 该接口仅支持version3.0的通道。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDomain
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
ListenerId String 监听器ID。
Domain String 需要创建的域名,一个监听器下最大支持100个域名。
CertificateId String 服务器证书,用于客户端与GAAP的HTTPS的交互。
ClientCertificateId String 客户端CA证书,用于客户端与GAAP的HTTPS的交互。
仅当采用双向认证的方式时,需要设置该字段。

3. 输出参数

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

4. 示例

示例1 CreateDomain

输入示例

https://gaap.tencentcloudapi.com/?Action=CreateDomain
&ListenerId=0
&Domain=a.a.com
&CertificateId=abc
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
FailedOperation.DomainAlreadyExisted 该域名在监听器下已使用。
FailedOperation.InvalidListenerProtocol 无效的监听器协议。
FailedOperation.LimitNumofDomains 域名的数量超过限制。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.ProxyVersionNotSupport 不支持该版本通道。
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
ResourceNotFound 资源不存在