tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeIntlDomainList

Last updated: 2023-03-28 10:53:02

1. API Description

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

This API is used to query the "My domains" list.

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: DescribeIntlDomainList.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region No String Common Params. This parameter is not required for this API.
Offset No Integer The page number in pagination cases.
Limit No Integer The number of records on each page in pagination cases.
KeyWord No String The domain keyword for fuzzy search.
OrderByRegTime No Integer The registration time sort order. Valid values: 1 (descending), 2 (ascending).
OrderByExpireTime No Integer The expiration time sort order. Valid values: 1 (descending), 2 (ascending).
Status No String The domain status.
all: All domains.
UrgentNeedRenew: The domains that are in urgent need of renewal.
RedemptionPending: The domains that are in urgent need of redemption.
nosubmit: The domains with unverified identities.
tran: The domains that are being transferred in.
DnsStatus No Integer The DNS type. Valid values: 1 (DNSPod), 2 (others).
OrderByDomainName No Integer The domain sort order. Valid values: 1 (descending), 2 (ascending).

3. Output Parameters

Parameter Name Type Description
DomainSet Array of IntlDomainInfo The domain information set.
TotalCount Integer The total number of domains.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of domains

Input Example

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

{
    "Offset": 20,
    "Limit": 30
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "DomainSet": [
            {
                "Status": "xx",
                "IsPremium": true,
                "DomainId": "xx",
                "CanRenewYears": 0,
                "DomainName": "xx",
                "RegistrarType": "xx",
                "ModifyStatus": "xx",
                "DnsModifyStatus": "xx",
                "TemplateId": "xx",
                "WhoisPrivacy": 0,
                "DomainStatus": [
                    "xx"
                ],
                "Uin": "xx",
                "AutoRenew": 0,
                "ExpirationDate": "xx",
                "Dns": [
                    "xx"
                ],
                "ExpireMessage": 0,
                "DnsStatus": 0,
                "ContactInfo": {
                    "Province": "xx",
                    "City": "xx",
                    "OrganizationName": "xx",
                    "FirstName": "xx",
                    "RegistrantType": "xx",
                    "Country": "xx",
                    "CompanyName": "xx",
                    "RegistrantName": "xx",
                    "Telephone": "xx",
                    "ZipCode": "xx",
                    "Street": "xx",
                    "LastName": "xx",
                    "Email": "xx"
                },
                "SupportDnssec": true,
                "CreationDate": "xx"
            }
        ],
        "RequestId": "xx"
    }
}

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
InternalError.DescribeDomainListErr Failed to query the "My domains" list.
InternalError.ForbiddenRequest Forbidden request.
InternalError.MethodNotMatch Method mismatch.
InternalError.ReadBodyError Failed to read the body.
InvalidParameterValue.InvalidParameterFormat Invalid parameter value.
MissingParameter.ActionNotFound The route is not defined.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy