1. 接口描述
接口请求域名： scf.tencentcloudapi.com 。
创建自定义域名
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCustomDomain。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Domain | 是 | String | 域名，不支持泛域名 示例值：www.xxx.com |
| Protocol | 是 | String | 协议，取值范围：HTTP, HTTPS, HTTP&HTTPS 示例值：HTTP |
| EndpointsConfig.N | 是 | Array of EndpointsConf | 路由配置 |
| CertConfig | 否 | CertConf | 证书配置信息，有使用HTTPS协议时候必须传 |
| WafConfig | 否 | WafConf | web 应用防火墙配置 |
| Tags.N | 否 | Array of Tag | 标签 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
创建一个自定义域名，关闭了waf防护，路由配置开启重写策略，该策略是通配符匹配替换。
输入示例
POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomDomain
<公共请求参数>
{
"Domain": "www.ccc.com",
"Protocol": "HTTP&HTTPS",
"CertConfig": {
"CertificateId": "BxxJ3DK7"
},
"EndpointsConfig": [
{
"PathMatch": "/aa/*",
"Namespace": "default",
"FunctionName": "test1",
"Qualifier": "$LATEST",
"PathRewrite": [
{
"Path": "/aa/bb/*",
"Type": "WildcardRules",
"Rewrite": "/$"
}
]
}
],
"WafConfig": {
"WafOpen": "CLOSE",
"WafInstanceId": "waf_2kzh3vlq0umkkha9"
}
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例2 示例2
创建一个自定义域名，开启了waf 防护，路由配置开启重写策略，该策略是精确路径匹配替换。
输入示例
POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomDomain
<公共请求参数>
{
"Domain": "www.ccc.com",
"Protocol": "HTTP&HTTPS",
"CertConfig": {
"CertificateId": "BxxJ3DK7"
},
"EndpointsConfig": [
{
"PathMatch": "/aa/",
"Namespace": "default",
"FunctionName": "test1",
"Qualifier": "1",
"PathRewrite": [
{
"Path": "/aa/",
"Type": "WildcardRules",
"Rewrite": "/$"
}
]
}
],
"WafConfig": {
"WafOpen": "OPEN",
"WafInstanceId": "waf_2kzh3vlq0umkkha9"
}
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CNAME | CNAME解析错误 |
| InvalidParameterValue.Domain | 域名参数非法 |
