DescribeZoneSetting
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is an old version. EdgeOne has fully upgraded the APIs related to the rule engine. For details, please refer to DescribeL7AccSetting.
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: DescribeZoneSetting. |
| 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ZoneSetting | ZoneSetting | The site configuration. Note: This field may return null, indicating that no valid values can be obtained. |
| 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 Site Configuration
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZoneSetting
<Common request parameters>
{
"ZoneId": "zone-21xfqlh4qjee"
}Output Example
{
"Response": {
"RequestId": "88215c08-67de-4c7d-974e-a14461816f5b",
"ZoneSetting": {
"AccelerateMainland": {
"Switch": "off"
},
"Area": "global",
"CacheConfig": {
"Cache": {
"CacheTime": 2592000,
"Switch": "off"
},
"FollowOrigin": {
"DefaultCache": "on",
"DefaultCacheStrategy": "on",
"DefaultCacheTime": 0,
"Switch": "on"
},
"NoCache": {
"Switch": "off"
}
},
"CacheKey": {
"FullUrlCache": "on",
"IgnoreCase": "off",
"QueryString": {
"Action": "includeCustom",
"Switch": "off",
"Value": []
}
},
"CachePrefresh": {
"Percent": 90,
"Switch": "off"
},
"ClientIpCountry": {
"HeaderName": "",
"Switch": "off"
},
"ClientIpHeader": {
"HeaderName": "",
"Switch": "off"
},
"Compression": {
"Algorithms": [
"brotli",
"gzip"
],
"Switch": "on"
},
"ForceRedirect": {
"RedirectStatusCode": 302,
"Switch": "off"
},
"Grpc": {
"Switch": "off"
},
"Https": {
"ApplyType": "none",
"CertInfo": [],
"CipherSuite": "loose-v2023",
"Hsts": {
"IncludeSubDomains": "off",
"MaxAge": 0,
"Preload": "off",
"Switch": "off"
},
"Http2": "on",
"OcspStapling": "off",
"TlsVersion": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
]
},
"ImageOptimize": {
"Switch": "off"
},
"Ipv6": {
"Switch": "off"
},
"MaxAge": {
"FollowOrigin": "on",
"MaxAgeTime": 600
},
"OfflineCache": {
"Switch": "on"
},
"Origin": {
"Origins": [
"30.12.34.23"
],
"BackupOrigins": [
"30.12.34.11"
],
"OriginPullProtocol": "follow",
"CosPrivateAccess": "off"
},
"PostMaxSize": {
"MaxSize": 524288000,
"Switch": "on"
},
"Quic": {
"Switch": "off"
},
"SmartRouting": {
"Switch": "off"
},
"StandardDebug": {
"AllowClientIPList": [],
"ExpireTime": "1969-12-31T16:00:00Z",
"Switch": "off"
},
"UpstreamHttp2": {
"Switch": "off"
},
"WebSocket": {
"Switch": "off",
"Timeout": 30
},
"JITVideoProcess": {
"Switch": "off"
},
"ZoneName": "wxlagame.com"
}
}
}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.RouteError | The backend routing address is incorrect. |
| InternalError.SystemError | Internal system error. |
| 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. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |