接口请求域名: privatedns.intl.tencentcloudapi.com 。
创建私有域
默认接口请求频率限制:10次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreatePrivateZone。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Domain | 是 | String | 域名,格式必须是标准的TLD |
| TagSet.N | 否 | Array of TagInfo | 创建私有域的同时,为其打上标签 |
| VpcSet.N | 否 | Array of VpcInfo | 创建私有域的同时,将其关联至VPC |
| Remark | 否 | String | 备注 |
| DnsForwardStatus | 否 | String | 是否开启子域名递归, ENABLED, DISABLED。默认值为ENABLED |
| AccountVpcSet.N | 否 | Array of AccountVpcInfo | 创建私有域同时绑定关联账号的VPC |
| CnameSpeedupStatus | 否 | String | 是否CNAME加速:ENABLED,DISABLED,默认值为ENABLED |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ZoneId | String | 私有域ID, zone-12sa5ce78 |
| Domain | String | 私有域名 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: privatedns.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateZone
<公共请求参数>
{
"Domain": "a.com",
"TagSet": [
{
"TagKey": "owner",
"TagValue": "xxxxxxxxxx"
}
],
"VpcSet": [
{
"Region": "ap-guangzhou",
"UniqVpcId": "vpc-dw3911rr"
}
],
"AccountVpcSet": [
{
"Uin": "1000458200",
"Region": "ap-guangzhou",
"UniqVpcId": "vpc-adsebmy1",
"VpcName": "vpcname"
}
],
"Remark": "测试域名",
"DnsForwardStatus": "ENABLED",
"CnameSpeedupStatus": "ENABLED"
}
{
"Response": {
"RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
"ZoneId": "zone-12345678",
"Domain": "a.com"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.CreateZoneFailed | 私有域创建失败。 |
| InternalError | 内部错误。 |
| InternalError.UndefiendError | 错误未定义。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.IllegalCidr | 非法CIDR。 |
| InvalidParameter.IllegalDomain | 域名不正确。 |
| InvalidParameter.IllegalDomainTld | 顶级域名不正确。 |
| InvalidParameter.IllegalRecord | 记录不合法。 |
| InvalidParameter.IllegalRecordValue | 无效的记录值。 |
| InvalidParameter.RecordLevelExceed | 记录层级超过限制。 |
| InvalidParameter.VpcBinded | VPC已绑定其它解析域。 |
| InvalidParameter.VpcBindedMainDomain | 当前VPC已关联相同主域名。 |
| InvalidParameter.VpcPtrZoneBindExceed | VPC关联反解析域超过限制。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.ReservedDomain | 内部保留域名,不支持创建。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.TldOutOfLimit | 超过自定义TLD额度。 |
| LimitExceeded.TldOutOfRange | 使用自定义TLD的私有域超过总额度。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ServiceNotSubscribed | 私有域解析服务未开通。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.TldPackageExpired | TLD增值包已过期。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.RoleUnAuthorized | 角色未授权。 |
| UnauthorizedOperation.UnauthorizedAccount | 未实名账号。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.AccountNotBound | 账号未绑定。 |
| UnsupportedOperation.NotSupportDnsForward | 不支持设置子域名递归解析。 |
文档反馈