1. API Description
Domain name for API request: dnspod.tencentcloudapi.com.
This API is used to get the list of domains.
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: DescribeDomainList. |
| 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. |
| Type | No | String | The domain group type. Valid values: ALL (default), MINE, SHARE, ISMARK, PAUSE, VIP, RECENT, SHARE_OUT, and FREE. |
| Offset | No | Integer | Record offset starting from 0. Default value: 0. |
| Limit | No | Integer | Number of domains to be obtained. For example, 20 indicates to obtain 20 domains. Default value: 3000. |
| GroupId | No | Integer | Group ID, which can be passed in to get all domains in the specified group |
| Keyword | No | String | Keyword for searching for a domain |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DomainCountInfo | DomainCountInfo | Statistics on the list page |
| DomainList | Array of DomainListItem | Domain list |
| 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
This example shows you how to get the list of domains.
Input Example
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainList
<Common request parameters>
{
"Type": "ALL",
"Keyword": "dnspod",
"Limit": 1,
"Offset": 0,
"GroupId": 1
}
Output Example
{
"Response": {
"DomainCountInfo": {
"AllTotal": 35,
"DomainTotal": 1,
"ErrorTotal": 28,
"GroupTotal": 0,
"LockTotal": 1,
"MineTotal": 28,
"PauseTotal": 1,
"ShareOutTotal": 4,
"ShareTotal": 7,
"SpamTotal": 0,
"VipExpire": 0,
"VipTotal": 4
},
"DomainList": [
{
"CNAMESpeedup": "DISABLE",
"CreatedOn": "2021-05-06 20:40:39",
"DNSStatus": "DNSERROR",
"DomainId": 12614766,
"EffectiveDNS": [
"ns3.dnsv5.com",
"ns4.dnsv5.com"
],
"Grade": "DP_ULTRA",
"GradeLevel": 10,
"GradeTitle": "Premium",
"GroupId": 1,
"IsVip": "YES",
"Name": "dnspod.com",
"Owner": "qcloud_uin_000000000@qcloud.com",
"Punycode": "dnspod.com",
"RecordCount": 0,
"Remark": "",
"SearchEnginePush": "NO",
"Status": "ENABLE",
"TTL": 600,
"UpdatedOn": "2023-03-09 11:51:56",
"VipAutoRenew": "YES",
"VipEndAt": "2024-01-16 15:56:31",
"VipStartAt": "2023-01-16 15:56:31"
}
],
"RequestId": "bfb3f27e-4dba-4a5c-9aff-08d1c27d1c61"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.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.GroupIdInvalid | The group ID is incorrect. |
| InvalidParameter.OffsetInvalid | The pagination offset value is incorrect. |
| InvalidParameter.OperateFailed | Operation failed. Please try again later. |
| InvalidParameter.ResultMoreThan500 | The search results contain more than 500 entries. Add one or more keywords. |
| InvalidParameterValue.LimitInvalid | Error in number of entries per page. |
| OperationDenied.AccessDenied | You have no permission for this operation. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| RequestLimitExceeded.RequestLimitExceeded | The number of API requests exceeds the limit. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?