- Updates and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Getting Started
- Configuration Guide
- Permission Management
- Use Cases
- Best Practice
- API Documentation
- FAQ
- Troubleshooting Methods
- CDN Service Level Agreement
- Glossary
- Updates and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Getting Started
- Configuration Guide
- Permission Management
- Use Cases
- Best Practice
- API Documentation
- FAQ
- Troubleshooting Methods
- CDN Service Level Agreement
- Glossary
1. API Description
Domain name for API request: cdn.tencentcloudapi.com.
This API is used to query the complete configuration information of CDN acceleration domain names (inside and outside mainland China).
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: DescribeDomainsConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2018-06-06. |
| Region | No | String | Common Params. 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. |
| Sort | No | Sort | Sorting rules |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Domains | Array of DetailDomain | List of domain names |
| TotalNumber | Integer | Number of domain names that match the specified 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. |
4. Example
Example1 Querying the domain name configuration
Input Example
https://cdn.tencentcloudapi.com/?Action=DescribeDomainsConfig
&Offset=0
&Limit=1
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "07f7dd0b-3936-4bdb-9a85-92b4e20d1b03",
"Domains": [
{
"AccessControl": {
"Switch": "off",
"AccessControlRules": [],
"ReturnCode": 403
},
"AccessPort": [
80,
8080,
443
],
"Advance": "on",
"AdvanceSet": [
{
"Name": "edge",
"Value": "on"
},
{
"Name": "last",
"Value": "off"
},
{
"Name": "full",
"Value": "off"
},
{
"Name": "quic",
"Value": "off"
}
],
"AdvancedAuthentication": {
"Switch": "off",
"TypeA": null,
"TypeB": null,
"TypeC": null,
"TypeD": null,
"TypeE": null,
"TypeF": null
},
"AppId": 123456789,
"Area": "global",
"Authentication": {
"Switch": "off",
"TypeA": null,
"TypeB": null,
"TypeC": null,
"TypeD": null
},
"AwsPrivateAccess": {
"Switch": "off",
"AccessKey": "",
"SecretKey": ""
},
"BandwidthAlert": {
"Switch": "off",
"BpsThreshold": 10000000000,
"CounterMeasure": "RETURN_404",
"LastTriggerTime": null
},
"Cache": {
"RuleCache": [
{
"CacheConfig": {
"Cache": {
"CacheTime": 86400,
"CompareMaxAge": "off",
"IgnoreCacheControl": "off",
"IgnoreSetCookie": "off",
"Switch": "on"
},
"NoCache": {
"Switch": "off",
"Revalidate": "off"
},
"FollowOrigin": {
"Switch": "off"
}
},
"RulePaths": [
"*"
],
"RuleType": "all"
}
],
"SimpleCache": null,
"AdvancedCache": null
},
"CacheKey": {
"FullUrlCache": "off",
"CacheTag": {
"Switch": "off",
"Value": null
},
"Cookie": {
"Switch": "off",
"Value": ""
},
"Header": {
"Switch": "off",
"Value": ""
},
"IgnoreCase": "off",
"KeyRules": [
{
"FullUrlCache": "on",
"IgnoreCase": "off",
"QueryString": {
"Switch": "off",
"Action": null,
"Value": ""
},
"RulePaths": [
".1"
],
"RuleType": "file",
"RuleTag": "user"
}
],
"QueryString": {
"Switch": "off",
"Reorder": "off",
"Action": null,
"Value": ""
},
"Scheme": {
"Switch": "off"
}
},
"Cname": "www.test.com.cdn.dnsv1.com",
"Compatibility": {
"Code": 0
},
"Compression": {
"Switch": "on",
"CompressionRules": [
{
"Compress": true,
"FileExtensions": [
"js",
"html",
"css",
"xml",
"json",
"shtml",
"htm"
],
"MinLength": 256,
"MaxLength": 2097152,
"Algorithms": [
"gzip"
]
}
]
},
"CreateTime": "2020-12-14 21:14:36",
"Disable": "normal",
"Domain": "www.test.com",
"DownstreamCapping": {
"Switch": "off",
"CappingRules": []
},
"ErrorPage": {
"Switch": "off",
"PageRules": []
},
"FollowRedirect": {
"Switch": "off"
},
"ForceRedirect": {
"Switch": "off",
"RedirectType": "http",
"RedirectStatusCode": 302,
"CarryHeaders": "off"
},
"Https": {
"Switch": "off",
"Http2": "off",
"Spdy": "off",
"OcspStapling": "off",
"VerifyClient": "off",
"CertInfo": null,
"ClientCertInfo": null,
"TlsVersion": [
"TLSv1",
"TLSv1.1",
"TLSv1.2"
],
"Hsts": {
"Switch": "off",
"MaxAge": 0,
"IncludeSubDomains": "off"
},
"SslStatus": "closed"
},
"ImageOptimization": {
"WebpAdapter": {
"Switch": "off"
},
"TpgAdapter": {
"Switch": "off"
},
"GuetzliAdapter": {
"Switch": "off"
}
},
"IpFilter": {
"Switch": "off",
"FilterType": "blacklist",
"Filters": [],
"FilterRules": []
},
"IpFreqLimit": {
"Switch": "off",
"Qps": null
},
"Ipv6": {
"Switch": "off"
},
"Ipv6Access": {
"Switch": "off"
},
"MaxAge": {
"MaxAgeRules": [
{
"MaxAgeType": "all",
"MaxAgeContents": [
"*"
],
"MaxAgeTime": 0,
"FollowOrigin": "on"
}
],
"Switch": "on"
},
"OfflineCache": {
"Switch": "off"
},
"Origin": {
"Origins": [
"1.1.1.1"
],
"OriginType": "ip",
"ServerName": "www.a.com",
"CosPrivateAccess": "off",
"OriginPullProtocol": "http",
"BackupOrigins": [
"2.2.2.2"
],
"BackupOriginType": "ip",
"BackupServerName": "www.a.com",
"PathRules": [],
"BasePath": null,
"PathBasedOrigin": [],
"Sni": {
"Switch": "off",
"ServerName": null
}
},
"OriginAuthentication": null,
"OriginCombine": {
"Switch": "off"
},
"OriginPullOptimization": {
"Switch": "off",
"OptimizationType": ""
},
"OriginPullTimeout": {
"ConnectTimeout": 5,
"ReceiveTimeout": 10
},
"PostMaxSize": {
"Switch": "off",
"MaxSize": 33554432
},
"ProjectId": 0,
"Quic": {
"Switch": "off"
},
"RangeOriginPull": {
"Switch": "off"
},
"Readonly": "normal",
"Referer": {
"Switch": "off",
"RefererRules": [
{
"RuleType": "all",
"RulePaths": [
"*"
],
"RefererType": "whitelist",
"Referers": [
"1.1.1.1"
],
"AllowEmpty": false
}
]
},
"RequestHeader": {
"Switch": "off",
"HeaderRules": []
},
"ResourceId": "cdn-5ndlcoas",
"ResponseHeader": {
"HeaderRules": [],
"Switch": "off"
},
"ResponseHeaderCache": {
"Switch": "on"
},
"SecurityConfig": {
"Switch": "off"
},
"Seo": {
"Switch": "off"
},
"ServiceType": "web",
"SpecificConfig": {
"Mainland": null,
"Overseas": null
},
"Status": "online",
"StatusCodeCache": {
"CacheRules": [
{
"StatusCode": "403",
"CacheTime": 0
}
],
"Switch": "on"
},
"Tag": [
{
"TagKey": "testfornewtag",
"TagValue": "brandnew"
},
{
"TagKey": "zzz",
"TagValue": "aaa"
}
],
"UpdateTime": "2021-03-16 21:04:04",
"UrlRedirect": {
"Switch": "off",
"PathRules": []
},
"UserAgentFilter": {
"Switch": "off",
"FilterRules": []
},
"VideoSeek": {
"Switch": "off"
},
"OssPrivateAccess": null,
"WebSocket": null,
"RemoteAuthentication": null,
"ShareCname": null,
"ParentHost": null,
"RuleEngine": null
}
],
"TotalNumber": 1
}
}
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 |
|---|---|
| InternalError.CamSystemError | Authentication system internal error. |
| InternalError.CdnConfigError | Failed to update the domain name configuration. |
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnQuerySystemError | Internal error. Please try again or contact the customer service for assistance. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InternalError.Error | Service internal error. Please submit a ticket for troubleshooting. |
| InternalError.ProxyServer | Internal service error. Please submit a ticket for troubleshooting. |
| InternalError.RouteError | Internal service error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CDNStatusInvalidDomain | Invalid domain name status. |
| InvalidParameter.CdnCertNoCertInfo | Invalid certificate. Please check and try again. |
| 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 | Unable to find the domain name. Please make sure the domain name is correct. |
| 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 project is not authorized for the sub-account. |
| 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. |
| UnauthorizedOperation.OpNoAuth | This operation is not supported currently. Please submit a ticket for assistance. |
| UnauthorizedOperation.OperationTooOften | Too many calling attempts. |
Yes
No
Was this page helpful?