1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
本接口CreateHTTPServiceRoute用于创建HTTP访问服务路由。如果不传Domain.Routes,仅创建域名信息。首次创建域名后需要调用DescribeHTTPServiceRoute查询域名状态,如果状态是PROCESSING,需要轮询查询域名状态直到SUCCESS或者FAIL。如果状态是FAIL,可以删除后重新创建。创建成功后域名可能无法访问,原因是异步下发的路由,可通过http或者https探测路由是否下发,如果http访问返回404或者https访问握手失败,可等待一会再试,直到访问正常。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateHTTPServiceRoute。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:*-7ezncwdd421446 |
| Domain | 是 | HTTPServiceDomainParam | 域名路由信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建完整路由
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHTTPServiceRoute
<公共请求参数>
{
"EnvId": "*****************-7ezncwdd421446",
"Domain": {
"Domain": "xxx.***************.cn",
"AccessType": "DIRECT",
"CertId": "VF******",
"Protocol": "HTTP_AND_HTTPS",
"CustomCname": "xxx.*********************.dns.com",
"Enable": true,
"Routes": [
{
"Path": "/api/v1",
"UpstreamResourceType": "CBR",
"UpstreamResourceName": "my-service",
"EnableSafeDomain": false,
"EnablePathTransmission": false,
"QPSPolicy": {
"QPSTotal": 100,
"QPSPerClient": {
"LimitBy": "ClientIP",
"LimitValue": 10
}
},
"Enable": true
}
]
}
}
输出示例
{
"Response": {
"RequestId": "424af1fa-ea4d-4a63-b96c-b374d5dfb020"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.CertVerifyFailed | 证书验证失败 |
| InvalidParameter.EnvId | 环境ID非法。 |
| InvalidParameter.HTTPServiceDomainNotICP | HTTP访问服务没有ICP备案 |
| LimitExceeded.HTTPServiceDomain | HTTP访问服务域名超过限制 |
| LimitExceeded.HTTPServiceRoute | HTTP访问服务路由超过上限 |
| OperationDenied.HTTPServiceDomainInBlacklist | 域名在黑名单中,无法创建 |
| OperationDenied.NonInternalAccount | 非内部账号禁止操作 |
| ResourceInUse.HTTPServiceDomain | HTTP访问服务域名已经存在 |
| ResourceInUse.HTTPServiceRoute | HTTP访问服务路由已存在 |
| ResourceNotFound.HTTPServiceDomain | HTTP访问服务域名不存在 |