1. API Description
Domain name for API request: dnspod.intl.tencentcloudapi.com.
This API is used to get the list of domain aliases.
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.
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: DescribeDomainAliasList. |
| 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 |
Domain |
| DomainId |
No |
Integer |
The domain ID. DomainId takes priority over Domain. If DomainId is passed in, Domain is ignored. You can view all Domain and DomainId values via the DescribeDomainList API. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| DomainAliasList |
Array of DomainAliasInfo |
List of domain aliases |
| 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 domain aliases
POST / HTTP/1.1
Host: dnspod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainAliasList
<Common request parameters>
{
"Domain": "myfm.cc"
}
Output Example
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
"DomainAliasList": [
{
"DomainAlias": "cc.cc",
"Id": 16063
}
]
}
}
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 |
| 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.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. |
| InvalidParameterValue.DomainNotExists |
The current domain is incorrect. Return to the previous step and try again. |
| MissingParameter |
The parameter is missing. |
| OperationDenied.DomainOwnerAllowedOnly |
Only the domain owner can perform this operation. |
| OperationDenied.NoPermissionToOperateDomain |
You have no permission to perform operations on the current domain. Return to the domain list. |
| ResourceNotFound |
The resource does not exist. |
| ResourceNotFound.NoDataOfDomainAlias |
There is no domain alias. |