DescribeAccelerationDomains
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query domain name information of a site, including the acceleration domain name, origin, and domain name status. You can query the information of all domain names, or specific domain names by specifying filters information.
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: DescribeAccelerationDomains. |
| 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 | ID of the site related with the acceleration domain name. |
| Offset | No | Integer | Offset for paginated queries. Default value: 0. |
| Limit | No | Integer | Limit on paginated queries. Default value: 20. Maximum value: 200. |
| Filters.N | No | Array of AdvancedFilter | Filter criteria. The maximum number of Filters.Values is 20. If this parameter is not input, all domain name information under the current zone-id will be returned. The detailed filter criteria are as follows: |
| Order | No | String | Sort the returned results according to this field. Values include:created_on: Creation time of the acceleration domain namedomain-name: (Default) Acceleration domain name. |
| Direction | No | String | Sort direction. If the field value is number, sort by the numeric value. If the field value is text, sort by the ascill code. Values include:asc: Ascending order.desc: Descending order.asc. |
| Match | No | String | The match mode. Values:all: Return all matches.any: Return any match.all. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total of matched alias domain names. |
| AccelerationDomains | Array of AccelerationDomain | Information of all matched acceleration 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. |
4. Example
Example1 Querying Information of Domain Names Under a Specified Site
This example shows you how to query the information of all acceleration domain names with the origin server type of IP_DOMAIN under the specified zone-id, and sort the results in descending order by creation time.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccelerationDomains
<Common request parameters>
{
"ZoneId": "zone-20hyebgyfsko",
"Filters": [
{
"Fuzzy": true,
"Values": [
"IP_DOMAIN"
],
"Name": "origin-type"
}
],
"Direction": "desc",
"Order": "created_on",
"Match": "all"
}
Output Example
{
"Response": {
"TotalCount": 1,
"AccelerationDomains": [
{
"ZoneId": "zone-20hyebgyfsko",
"DomainName": "www.qq.com",
"DomainStatus": "online",
"OriginDetail": {
"OriginType": "IP_DOMAIN",
"Origin": "origin.qq.com",
"BackupOrigin": "",
"PrivateParameters": [],
"PrivateAccess": "",
"OriginGroupName": "",
"BackOriginGroupName": ""
},
"Certificate": {
"Mode": "sslcert",
"List": [
{
"CertId": "J2JqATrsx"
}
],
"ClientCertInfo": {
"Switch": "on",
"CertInfos": [
{
"CertId": "J2JqATrsx"
}
]
},
"UpstreamCertInfo": {
"UpstreamMutualTLS": {
"Switch": "on",
"CertInfos": [
{
"CertId": "J2JqATrsx"
}
]
}
}
},
"IdentificationStatus": "finished",
"Cname": "www.qq.com.eo.dnse3.com",
"CreatedOn": "2020-09-22T00:00:00+00:00",
"ModifiedOn": "2020-09-22T00:00:00+00:00"
}
],
"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
}
}
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 Node.js
- 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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| InvalidParameter.DomainOnTrafficScheduling | Traffic scheduling is already enabled for the current domain name. |
| InvalidParameter.TooManyFilterValues | Too many filter values. |
| OperationDenied | Operation denied. |
| ResourceNotFound | The resource doesn’t exist. |
| 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. |