tencent cloud



Last updated: 2024-04-07 11:57:47

    1. API Description

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

    This API is used to get the list of records for 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: DescribePrivateZoneRecordList.
    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.
    ZoneId Yes String Private domain ID: zone-xxxxxx
    Filters.N No Array of Filter Filter parameter
    Offset No Integer Pagination offset, starting from 0
    Limit No Integer Number of entries per page. Maximum value: 100. Default value: 20

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of DNS records
    RecordSet Array of PrivateZoneRecord List of DNS records
    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 Getting the list of DNS records

    Input Example

    POST / HTTP/1.1
    Host: privatedns.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribePrivateZoneRecordList
    <Common request parameters>
        "ZoneId": "zone-123456",
        "Limit": 2,
        "Offset": 0,
        "Filters": [
                "Name": "Value",
                "Values": [
                "Name": "RecordType",
                "Values": [

    Output Example

        "Response": {
            "RequestId": "8a4ea9cc-b1df-f8f8-ffe7efbe98f9ff85",
            "TotalCount": 5,
            "RecordSet": [
                    "RecordId": "66",
                    "ZoneId": "zone-123456",
                    "SubDomain": "b",
                    "RecordType": "A",
                    "RecordValue": "",
                    "TTL": 600,
                    "MX": 0,
                    "Status": "enabled",
                    "Extra": "weight:100",
                    "CreatedOn": "2020-11-16 17:16:24",
                    "UpdatedOn": "2020-11-16 17:16:24",
                    "Weight": 100
                    "RecordId": "65",
                    "ZoneId": "zone-123456",
                    "SubDomain": "mail",
                    "RecordType": "MX",
                    "RecordValue": "",
                    "TTL": 600,
                    "MX": 10,
                    "Status": "enabled",
                    "Extra": null,
                    "CreatedOn": "2020-11-16 17:14:02",
                    "UpdatedOn": "2020-11-16 17:14:02",
                    "Weight": null

    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.
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.UndefiendError Undefined error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.ZoneNotExists The domain does not exist.
    MissingParameter Missing parameter.
    ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
    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