Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the information of alias domain names.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeAliasDomains. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | The site ID. |
Offset | No | Integer | The page offset. Default value: 0 |
Limit | No | Integer | The paginated query limit. Default value: 20. Maximum value: 1000. |
Filters.N | No | Array of AdvancedFilter | Filter conditions. The maximum value for Filters.Values is 20. The detailed conditions are as follows: |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total eligible alias domain names. |
AliasDomains | Array of AliasDomain | Information of the eligible alias domain names. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAliasDomains
<Common request parameters>
{
"ZoneId": "zone-28569s6od5na",
"Limit": 20,
"Filters": [
{
"Values": [
"bbb.test.com"
],
"Name": "alias-name"
}
],
"Offset": 0
}
{
"Response": {
"TotalCount": 1,
"RequestId": "5ce6ee51-cda5-4e0d-a338-cff57a00bb3a",
"AliasDomains": [
{
"Status": "pending",
"ModifiedOn": "2020-09-22T00:00:00+00:00",
"TargetName": "aaa.example.com",
"CreatedOn": "2020-09-22T00:00:00+00:00",
"ZoneId": "zone-28569s6od5na",
"AliasName": "bbb.test.com",
"ForbidMode": 0
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Internal error. |
InternalError.ProxyServer | An unknown error occurred in the backend server. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |
Was this page helpful?