tencent cloud

All product documents
APIs
DocumentationAPIsPrivate DNSPrivate DNS APIsCreatePrivateZone
CreatePrivateZone
Last updated: 2024-04-07 11:57:52
CreatePrivateZone
Last updated: 2024-04-07 11:57:52

1. API Description

Domain name for API request: privatedns.tencentcloudapi.com.

This API is used to create a private domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreatePrivateZone.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region No String Common Params. This parameter is not required for this API.
Domain Yes String Domain name, which must be in the format of standard TLD
TagSet.N No Array of TagInfo Tags the private domain when it is created
VpcSet.N No Array of VpcInfo Associates the private domain to a VPC when it is created
Remark No String Remarks
DnsForwardStatus No String Whether to enable subdomain recursive DNS. Valid values: ENABLED (default) and DISABLED.
Vpcs.N No Array of VpcInfo Associates the private domain to a VPC when it is created
AccountVpcSet.N No Array of AccountVpcInfo List of authorized accounts' VPCs to associate with the private domain
CnameSpeedupStatus No String Whether to enable CNAME flattening. Valid values: ENABLED (default) and DISABLED.

3. Output Parameters

Parameter Name Type Description
ZoneId String Private domain ID, such as zone-xxxxxx
Domain String Private domain
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a private domain

Input Example

POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateZone
<Common request parameters>

{
    "Domain": "a.com",
    "TagSet": [
        {
            "TagKey": "owner",
            "TagValue": "xxxxxxxxxx"
        }
    ],
    "VpcSet": [
        {
            "Region": "ap-guangzhou",
            "UniqVpcId": "vpc-xxxxxl"
        }
    ],
    "AccountVpcSet": [
        {
            "Uin": "123456789",
            "Region": "ap-guangzhou",
            "UniqVpcId": "vpc-adsebmy1",
            "VpcName": "vpcname"
        }
    ],
    "Remark": "Test domain name",
    "DnsForwardStatus": "ENABLED",
    "CnameSpeedupStatus": "ENABLED"
}

Output Example

{
    "Response": {
        "RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
        "ZoneId": "41",
        "Domain": "a.com"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
FailedOperation.CreateZoneFailed Failed to create the private domain.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameter.IllegalCidr Invalid CIDR.
InvalidParameter.IllegalDomain Incorrect domain name.
InvalidParameter.IllegalDomainTld Incorrect top-level domain name.
InvalidParameter.IllegalRecord Invalid record.
InvalidParameter.IllegalRecordValue Invalid record value.
InvalidParameter.RecordLevelExceed The number of record levels exceeds the limit.
InvalidParameter.VpcBinded The VPC has been bound to another domain.
InvalidParameter.VpcBindedMainDomain The VPC has been associated with the same primary domain.
InvalidParameter.VpcPtrZoneBindExceed The number of PTR records associated with the VPC has reached the limit.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.ReservedDomain This is a reserved domain name and cannot be created.
LimitExceeded The quota limit is exceeded.
LimitExceeded.TldOutOfLimit Exceeded the custom TLD quota.
LimitExceeded.TldOutOfRange The number of private domains using the custom TLD exceeds the total quota.
MissingParameter Missing parameter.
OperationDenied The operation was denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.TldPackageExpired The TLD value-added package expired.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.RoleUnAuthorized Role not authorized.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.AccountNotBound Account not bound.
UnsupportedOperation.NotSupportDnsForward Subdomain recursive DNS is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support