tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRecordList

Last updated: 2023-03-20 11:02:10

1. API Description

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

This API is used to get the DNS records of a domain.

A maximum of 100 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: DescribeRecordList.
Version Yes String Common Params. The value used for this API: 2021-03-23.
Region No String Common Params. This parameter is not required for this API.
Domain Yes String The domain for which DNS records are to be obtained.
DomainId No Integer The ID of the domain whose DNS records are requested. If DomainId is passed in, Domain is ignored. You can view all Domain and DomainId values via the DescribeDomainList API.
Subdomain No String The host header of a DNS record. If this parameter is passed in, only the DNS record corresponding to this host header will be returned.
RecordType No String The type of DNS record, such as A, CNAME, NS, AAAA, explicit URL, implicit URL, CAA, or SPF record.
RecordLine No String The name of the split zone for which DNS records are requested. You can view split zones allowed by this domain via the DescribeRecordLineList API.
RecordLineId No String The ID of the split zone for which DNS records are requested. If RecordLineId is passed in, RecordLine is ignored. You can view split zones allowed by this domain via the DescribeRecordLineList API.
GroupId No Integer The group ID passed in to get DNS records in the group.
Keyword No String The keyword for searching for DNS records. Host headers and record values are supported.
SortField No String The sorting field. Available values: name, line, type, value, weight, mx, and ttl,updated_on.
SortType No String The sorting type. Valid values: ASC (ascending, default), DESC (descending).
Offset No Integer The offset. Default value: 0.
Limit No Integer The limit. It defaults to 100 and can be up to 3,000.

3. Output Parameters

Parameter Name Type Description
RecordCountInfo RecordCountInfo The record count info.
RecordList Array of RecordListItem The record list result.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the DNS records of a domain

Input Example

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

{
    "Offset": 0,
    "Limit": 2,
    "Domain": "shenjianing.com",
    "DomainId": 123,
    "Subdomain": "www",
    "Keyword": "dnspod",
    "RecordType": "NS",
    "RecordLine": "Default",
    "RecordLineId": "0",
    "SortField": "type",
    "SortType": "ASC",
    "GroupId": 34
}

Output Example

{
    "Response": {
        "RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276",
        "RecordCountInfo": {
            "SubdomainCount": 2,
            "TotalCount": 2,
            "ListCount": 2
        },
        "RecordList": [
            {
                "RecordId": 556507778,
                "Value": "f1g1ns1.dnspod.net.",
                "Status": "ENABLE",
                "UpdatedOn": "2021-03-28 11:27:09",
                "Name": "@",
                "Line": "Default",
                "LineId": "0",
                "Type": "NS",
                "Weight": null,
                "MonitorStatus": "",
                "Remark": "",
                "TTL": 86400,
                "MX": 0
            },
            {
                "RecordId": 556507779,
                "Value": "f1g1ns2.dnspod.net.",
                "Status": "ENABLE",
                "UpdatedOn": "2021-03-28 11:27:09",
                "Name": "@",
                "Line": "Default",
                "LineId": "0",
                "Type": "NS",
                "Weight": null,
                "MonitorStatus": "",
                "Remark": "",
                "TTL": 86400,
                "MX": 0
            }
        ]
    }
}

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 CAM signature/authentication error.
FailedOperation The operation failed.
FailedOperation.NotDomainOwner You are not the domain owner.
FailedOperation.NotRealNamedUser Your account identity has not been verified. Complete identity verification first before performing this operation.
FailedOperation.UnknowError The operation has no response. Try again later.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.DomainIdInvalid The domain number is incorrect.
InvalidParameter.DomainInvalid The domain is incorrect. Enter a top-level domain such as dnspod.cn.
InvalidParameter.DomainIsAliaser This domain is an alias of another domain.
InvalidParameter.OperateFailed Operation failed. Please try again later.
InvalidParameter.ParamInvalid Parameter format error.
InvalidParameter.RecordLineInvalid The record split zone is incorrect.
InvalidParameter.RecordTypeInvalid The record type is incorrect.
InvalidParameter.ResultMoreThan500 The search results contain more than 500 entries. Add one or more keywords.
InvalidParameterValue.DomainNotExists The current domain is incorrect. Return to the previous step and try again.
InvalidParameterValue.LimitInvalid Error in number of entries per page.
OperationDenied.NoPermissionToOperateDomain You have no permission to perform operations on the current domain. Return to the domain list.
RequestLimitExceeded The number of requests exceeds the frequency limit.
RequestLimitExceeded.RequestLimitExceeded The number of API requests exceeds the limit.
ResourceNotFound.NoDataOfRecord Empty record list.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy