tencent cloud

Feedback

DescribeZoneSetting

Last updated: 2022-09-01 15:05:22

1. API Description

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.

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-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String Site ID

3. Output Parameters

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.

4. Example

Example1 Querying the site configuration

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZoneSetting
<Common request parameters>

{
    "ZoneId": "zone-xxxx"
}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
InvalidParameter.SettingInvalidParam Incorrect domain name configuration.
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 add permissions first.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support