Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the site configuration.
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: DescribeZoneSetting. |
Version | Yes | String | Common Params. The value used for this API: 2022-01-06. |
Region | No | String | Common Params. This parameter is not required for this API. |
ZoneId | Yes | String | Site ID |
Parameter Name | Type | Description |
---|---|---|
Cache | CacheConfig | Cache expiration time configuration Note: This field may return null , indicating that no valid value can be obtained. |
CacheKey | CacheKey | Node cache key configuration Note: This field may return null , indicating that no valid value can be obtained. |
MaxAge | MaxAge | Browser cache configuration Note: This field may return null , indicating that no valid value can be obtained. |
OfflineCache | OfflineCache | Offline cache Note: This field may return null , indicating that no valid value can be obtained. |
Quic | Quic | QUIC access Note: This field may return null , indicating that no valid value can be obtained. |
PostMaxSize | PostMaxSize | POST transport configuration Note: This field may return null , indicating that no valid value can be obtained. |
Compression | Compression | Smart compression configuration Note: This field may return null , indicating that no valid value can be obtained. |
UpstreamHttp2 | UpstreamHttp2 | HTTP2 origin-pull configuration Note: This field may return null , indicating that no valid value can be obtained. |
ForceRedirect | ForceRedirect | Force HTTPS redirect configuration Note: This field may return null , indicating that no valid value can be obtained. |
Https | Https | HTTPS acceleration configuration Note: This field may return null , indicating that no valid value can be obtained. |
Origin | Origin | Origin server configuration Note: This field may return null , indicating that no valid value can be obtained. |
SmartRouting | SmartRouting | Dynamic acceleration configuration Note: This field may return null , indicating that no valid value can be obtained. |
ZoneId | String | Site ID |
Zone | String | Domain name of the site |
WebSocket | WebSocket | WebSocket configuration. Note: This field may return null , indicating that no valid value can be obtained. |
ClientIpHeader | ClientIp | Origin-pull client IP header configuration Note: This field may return null , indicating that no valid value can be obtained. |
CachePrefresh | CachePrefresh | Cache prefresh configuration Note: This field may return null , indicating that no valid value can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZoneSetting
<Common request parameters>
{
"ZoneId": "zone-xxxx"
}
{
"Response": {
"Origin": {
"OriginPullProtocol": "xx"
},
"CacheKey": {
"FullUrlCache": "xx",
"IgnoreCase": "xx",
"QueryString": {
"Action": "xx",
"Switch": "xx",
"Value": [
"xx"
]
}
},
"WebSocket": {
"Switch": "xx",
"Timeout": 0
},
"Compression": {
"Switch": "xx"
},
"Zone": "xx",
"ForceRedirect": {
"Switch": "xx",
"RedirectStatusCode": 0
},
"Https": {
"Hsts": {
"IncludeSubDomains": "xx",
"Preload": "xx",
"Switch": "xx",
"MaxAge": 0
},
"OcspStapling": "xx",
"TlsVersion": [
"xx"
],
"Http2": "xx"
},
"Cache": {
"FollowOrigin": {
"Switch": "xx"
},
"Cache": {
"CacheTime": 0,
"Switch": "xx",
"IgnoreCacheControl": "xx"
},
"NoCache": {
"Switch": "xx"
}
},
"PostMaxSize": {
"Switch": "xx",
"MaxSize": 0
},
"MaxAge": {
"FollowOrigin": "xx",
"MaxAgeTime": 0
},
"ZoneId": "xx",
"UpstreamHttp2": {
"Switch": "xx"
},
"ClientIpHeader": {
"HeaderName": "xx",
"Switch": "xx"
},
"OfflineCache": {
"Switch": "xx"
},
"Quic": {
"Switch": "xx"
},
"CachePrefresh": {
"Switch": "xx",
"Percent": 0
},
"SmartRouting": {
"Switch": "xx"
},
"RequestId": "xx"
}
}
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 |
---|---|
InvalidParameter.SettingInvalidParam | Configuration parameter error. |
InvalidParameter.ZoneNotFound | The site does not exist. |
OperationDenied | Operation denied. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
Was this page helpful?