创建私有域
最近更新时间: 2026-10-11 00:12:40
1. 接口描述
接口请求域名: vpcdns.api3.fincloud.tencent.com。
创建私有域
默认接口请求频率限制:10次/秒。
接口更新时间:2026-04-15 20:06:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreatePrivateZone |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-10-25 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| TagSet | 否 | 是 | Array of TagInfo | 创建私有域的同时,为其打上标签 示例值:查看 |
| Remark | 否 | 是 | String | 备注 示例值: 测试域名 |
| DnsForwardStatus | 否 | 是 | String | 是否开启子域名递归, ENABLED, DISABLED。默认值为ENABLED 示例值: ENABLED |
| Vpcs | 否 | 是 | Array of VpcInfo | 创建私有域的同时,将其关联至VPC 示例值:查看 |
| AccountVpcSet | 否 | 是 | Array of AccountVpcInfo | 创建私有域同时绑定关联账号的VPC 示例值:查看 |
| CnameSpeedupStatus | 否 | 是 | String | 是否CNAME加速:ENABLED,DISABLED,默认值为ENABLED 示例值: ENABLED |
| ForceBindVpc | 否 | 是 | Bool | 是否强制绑定冲突的vpc 示例值: false |
| SystemUin | 否 | 是 | String | 系统帐户uin,需要加白使用 示例值: 100000000328 |
| Domain | 是 | 是 | String | 域名,格式必须是标准的TLD 示例值: a.com |
| VpcSet | 否 | 是 | Array of VpcInfo | 创建私有域的同时,将其关联至VPC 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ZoneId | String | 私有域ID, zone-12sa5ce78 示例值: zone-12sa5ce78 |
| Domain | String | 私有域名 示例值: a.com |
| CreatedAt | Datetime | 请求返回时间 示例值: 2014-08-03 12:00:00 |
| CreatedAtIso | Datetime_iso | 请求响应时间Iso 示例值: 2024-06-04T15:30:00Z |
| DomainId | Uint64 | 域名id 示例值: 3 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| DryRunOperation | |
| ResourcesSoldOut | |
| AuthFailure | |
| OperationDenied | |
| RequestLimitExceeded | |
| InternalError.UndefiendError | 错误未定义 |
| InvalidParameter.IllegalCidr | 非法CIDR |
| InvalidParameter.IllegalDomain | 域名不正确 |
| InvalidParameter.IllegalDomainTld | 顶级域名不正确 |
| InvalidParameter.RecordLevelExceed | 记录层级超过限制 |
| InvalidParameter.IllegalRecord | 记录不合法 |
| InvalidParameter.IllegalRecordValue | 无效的记录值 |
| InvalidParameter.VpcBinded | |
| UnauthorizedOperation.UnauthorizedAccount | |
| FailedOperation.CreateZoneFailed | |
| ResourceNotFound.ServiceNotSubscribed | |
| UnauthorizedOperation.RoleUnAuthorized | |
| UnsupportedOperation.AccountNotBound | |
| InvalidParameter.VpcBindedMainDomain | |
| InvalidParameter.VpcPtrZoneBindExceed | |
| LimitExceeded.TldOutOfLimit | |
| ResourceUnavailable.TldPackageExpired | |
| LimitExceeded.TldOutOfRange | |
| InvalidParameterValue.ReservedDomain | |
| UnsupportedOperation.NotSupportDnsForward |
5. 示例
示例1 创建私有域
输入示例
{
"Domain": "a.com",
"TagSet": [
{
"TagKey": "owner",
"TagValue": "xxxxxxxxxx"
}
],
"VpcSet": [
{
"Region": "ap-region",
"UniqVpcId": "vpc-dw3911rr"
}
],
"AccountVpcSet": [
{
"Uin": "1000458200",
"Region": "ap-region",
"UniqVpcId": "vpc-adsebmy1",
"VpcName": "vpcname"
}
],
"Remark": "test name",
"DnsForwardStatus": "ENABLED",
"CnameSpeedupStatus": "ENABLED",
"ForceBindVpc": false
}
输出示例
{
"Response": {
"RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
"ZoneId": "zone-12345678",
"Domain": "a.com"
}
}