Domain name for API request: cdn.tencentcloudapi.com.
This API is used to query the basic configuration information of CDN acceleration domain names (inside and outside mainland China), including the project ID, service status, service type, creation time, and update time, etc.
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 parameter. The value used for this API: DescribeDomains. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-06-06. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Offset | No | Integer | Offset for paginated queries. Default value: 0 |
| Limit | No | Integer | Limit on paginated queries. Default value: 100. Maximum value: 1000. |
| Filters.N | No | Array of DomainFilter | Query condition filter, complex type. |
| Parameter Name | Type | Description |
|---|---|---|
| Domains | Array of BriefDomain | List of domain names |
| TotalNumber | Integer | The number of domain names that matched the query conditions Used for paginated queries |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdn.tencentcloudapi.com/?Action=DescribeDomains
&Offset=0
&Limit=1
&<Common request parameters>{
"Response": {
"RequestId": "64085ba1-4f77-437c-824d-55a188ab1386",
"Domains": [
{
"Area": "mainland",
"Cname": "www.test.com.cdn.dnsv1.com",
"CreateTime": "2019-11-15 15:20:46",
"Disable": "normal",
"Domain": "www.test.com",
"Origin": {
"Origins": [
"test-1251000004.cos.ap-chengdu.myqcloud.com"
],
"OriginType": "cos",
"ServerName": "test-1251000004.cos.ap-chengdu.myqcloud.com",
"CosPrivateAccess": "off",
"OriginPullProtocol": "http",
"BackupOrigins": [],
"BackupOriginType": null,
"BackupServerName": null
},
"ProjectId": 0,
"Readonly": "normal",
"ResourceId": "cdn-knocwo77",
"ServiceType": "web",
"Status": "offline",
"UpdateTime": "2019-12-04 11:13:09"
}
],
"TotalNumber": 201
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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.CdnConfigError | Failed to update the domain name configuration. |
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CDNStatusInvalidDomain | Invalid domain name status. |
| InvalidParameter.CdnInterfaceError | Internal API error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| InvalidParameter.CdnStatInvalidProjectId | Incorrect project ID. Please check and try again. |
| InvalidParameter.CdnStatTooManyDomains | The number of queried domain names reached the limit. |
| ResourceNotFound.CdnHostNotExists | This domain name does not exist under the account. Please check and try again. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| UnauthorizedOperation.CdnCamUnauthorized | No CAM policy is configured for the sub-account. |
| UnauthorizedOperation.CdnHostUnauthorized | The sub-account has no access to the CDN-accelerated domain name. |
| UnauthorizedOperation.CdnProjectUnauthorized | The sub-account has no access to the project. |
| UnauthorizedOperation.CdnTagUnauthorized | The sub-account has no access to the tag. |
| UnauthorizedOperation.CdnUserAuthFail | Fail to authenticate the CDN user. |
| UnauthorizedOperation.CdnUserAuthWait | The CDN user is pending authentication. |
| UnauthorizedOperation.CdnUserIsSuspended | The CDN service has been suspended. Please restart it and try again. |
Was this page helpful?