创建域名。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:CreateDomain |
create |
*Domain
|
无 | 无 |
请求语法
POST /v1/domains HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body。 |
{'key': 'value'} |
| name |
string |
是 |
域名名称，长度为 1～128 个字符，例如 abc.com。 |
abc.com |
| protocol |
string |
否 |
域名使用的协议类型。取值：HTTP、HTTPS。Dedicated 作用域必须设置，Serverless 作用域不允许设置。 枚举值：
|
HTTP |
| domainScope |
string |
否 |
域名作用域。取值：Dedicated（专享网关域名）、Serverless（Serverless 网关域名）。默认值：Dedicated。 枚举值：
|
Dedicated |
| forceHttps |
boolean |
否 |
设置 HTTPS 协议类型，是否开启强制 HTTPS 跳转（Serverless 必填；Dedicated+HTTPS 必填；Dedicated+HTTP 不校验） |
false |
| mTLSEnabled |
boolean |
否 |
是否开启 mTLS 双向认证（Dedicated+HTTPS 可选；为 true 时 ClientCACert 必填；Serverless 禁止） |
|
| certIdentifier |
string |
否 |
证书标识（Dedicated+HTTPS 必填，需通过可提交校验；Serverless 禁止；Dedicated+HTTP 不校验） |
1ef1da5f-38ed-69b3-****-037781890265 |
| caCertIdentifier |
string |
否 |
CA 证书标识（Dedicated+HTTPS 可选；Serverless 禁止；Dedicated+HTTP 不校验） |
1ef1da5f-38ed-69b3-****-037781890265 |
| clientCACert |
string |
否 |
客户端 CA 证书（Dedicated+HTTPS 条件必填（MTLSEnabled=true 时）；Serverless 禁止；Dedicated+HTTP 不校验） |
-----BEGIN CERTIFICATE----- MIIFBTCCAu2gAwIBAgIUORLpYPGSFD1YOP6PMbE7Wd/mpTQwDQYJKoZIhvcNAQEL BQAwE************************************************2VwVOJ2gqX3 YuGaxvIbDy0iQJ1GMerPRyzJTeVEtdIKT29u0PdFRr4KZWom35qX7G4= -----END CERTIFICATE----- |
| http2Option |
string |
否 |
HTTP/2 设置。取值：GlobalConfig（跟随全局配置）、Open（开启）、Close（关闭）。默认值：GlobalConfig。仅 Dedicated 作用域的 HTTPS 域名支持该设置。 枚举值：
|
Open |
| tlsMax |
string |
否 |
TLS 协议最大版本（Dedicated+HTTPS 可选，不传按 TlsMin 推导，需≥TlsMin；Serverless 禁止） |
TLS1.3 |
| tlsMin |
string |
否 |
TLS 协议最小版本（Dedicated+HTTPS 可选，不传默认 TLS 1.0，允许 TLS 1.0~1.3 兼容 TLSv1.x；Serverless 禁止） |
TLS1.0 |
| resourceGroupId |
string |
否 |
|
rg-aekzhiv7derfweq |
| tlsCipherSuitesConfig | TlsCipherSuitesConfig |
否 |
TLS 加密套件配置，包含配置类型、加密套件名称和支持的 TLS 版本。仅 Dedicated 作用域的 HTTPS 域名支持该配置。 |
|
| gatewayType |
string |
否 |
网关类型（可选；不传默认 API） 枚举值：
|
API |
| clientToken |
string |
否 |
幂等标识，由调用方生成全局唯一值（推荐 UUID），长度不超过 64 个字符。首次请求成功后约 24 小时内，携带相同 ClientToken 且请求参数一致的重复请求直接返回首次创建的 domainId，不重复创建域名；携带相同 ClientToken 但请求参数不一致时返回 IdempotentParameterMismatch；首次请求仍在处理中时返回 IdempotentProcessing；缺省时不启用幂等控制，行为与现有版本一致。 |
5f7a2c1e-9b3d-4e8f-a1c6-0d2b8e4f7a13 |
| dryRun |
boolean |
否 |
是否只做预检校验（dry run）。true 时执行与真实创建一致的全部同步校验（含既有测试域名的幂等判定）但不创建域名、不产生任何副作用；缺省或 false 时行为与现有版本一致。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 id，用于追溯 API 调用链路。 |
0C2D1C68-0D93-5561-8EE6-FDB7BF067A30 |
| data |
object |
响应数据。 |
|
| domainId |
string |
域名 id。 |
d-cpu1aullhtgkidg7sa4g |
| code |
string |
响应码。 |
Ok |
| message |
string |
响应消息。 |
success |
示例
正常返回示例
JSON格式
{
"requestId": "0C2D1C68-0D93-5561-8EE6-FDB7BF067A30",
"data": {
"domainId": "d-cpu1aullhtgkidg7sa4g"
},
"code": "Ok",
"message": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。