tencent cloud



Last updated: 2022-09-09 09:54:56

    1. API Description

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

    This API is used to query DNS records. Paging, sorting and filtering are supported.

    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: DescribeDnsRecords.
    Version Yes String Common Params. The value used for this API: 2022-01-06.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Filters.N No Array of DnsRecordFilter Query filter
    Order No String Sorts the order
    Direction No String Valid values: asc, and desc.
    Match No String Valid values: all, and any.
    Limit No Integer Limit on paginated queries. Default value: 100. Maximum value: 1000.
    Offset No Integer Offset for paginated queries. Default value: 0
    ZoneId No String Site ID

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Used for paginated query by total count
    Records Array of DnsRecord List of DNS records
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 dns_records

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDnsRecords
    <Common request parameters>
      "Direction": "xx",
      "ZoneId": "xx",
      "Limit": 0,
      "Filters": [
              "Fuzzy": true,
              "Values": [
              "Name": "xx"
      "Offset": 0,
      "Order": "xx",
      "Match": "xx"

    Output Example

      "Response": {
          "TotalCount": 0,
          "RequestId": "xx",
          "Records": [
                  "Status": "xx",
                  "Priority": 0,
                  "ModifiedOn": "2020-09-22T00:00:00+00:00",
                  "Name": "xx",
                  "CreatedOn": "2020-09-22T00:00:00+00:00",
                  "ZoneId": "xx",
                  "Content": "xx",
                  "Cname": "xx",
                  "Mode": "xx",
                  "Ttl": 0,
                  "Locked": true,
                  "Type": "xx",
                  "Id": "xx",
                  "ZoneName": "xx"

    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
    OperationDenied Operation denied.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    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