tencent cloud



Last updated: 2021-09-18 16:39:43

1. API Description

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

This API is used to get the private domain information.

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 parameter. The value used for this API: DescribePrivateZone.
Version Yes String Common parameter. The value used for this API: 2020-10-28.
Region No String Common parameter. This parameter is not required for this API.
ZoneId Yes String Domain name, which must be in the format of standard TLD

3. Output Parameters

Parameter Name Type Description
PrivateZone PrivateZone Private domain details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting private domain information

Input Example

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

    "ZoneId": "zone-123456"

Output Example

  "Response": {
    "RequestId": "520fea07-9c1b-4560-1c8axxxx5275",
    "PrivateZone": {
      "ZoneId": "zone-123456",
      "OwnerUin": 1111111111111111,
      "Domain": "a.com",
      "CreatedOn": "2020-05-28 16:28:10",
      "UpdatedOn": "2020-11-18 00:11:59",
      "RecordCount": 10,
      "Remark": "Test domain name",
      "VpcSet": [
          "UniqVpcId": "vpc-q1111115",
          "Region": "ap-guangzhou"
      "AccountVpcSet": [
          "UniqVpcId": "vpc-q1111115",
          "Region": "ap-guangzhou",
          "Uin": "123456789"
      "Status": "ENABLED",
      "DnsForwardStatus": "DISABLED",
      "Tags": [
          "TagKey": "tagKey",
          "TagValue": "tagValue"

5. Developer Resources


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.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameter.ZoneNotExists The domain does not exist.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
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.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Contact Us

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

Technical Support

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

7x24 Phone Support