有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

用于查询站点的所有配置信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeZoneSetting。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,详见产品支持的 地域列表
ZoneId String 站点ID。

3. 输出参数

参数名称 类型 描述
ZoneSetting ZoneSetting 站点配置。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询站点配置

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZoneSetting
<公共请求参数>

{
    "ZoneId": "zone-21xfqlh4qjee"
}

输出示例

{
    "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": "abc"
            },
            "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
            },
            "ZoneName": "wxlagame.com"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.RouteError 后端服务路由地址错误。
InternalError.SystemError 内部错误-系统错误。
InvalidParameter.SettingInvalidParam 配置项参数错误。
InvalidParameter.ZoneNotFound 站点不存在。
OperationDenied 操作被拒绝。
UnauthorizedOperation.CamUnauthorized Cam 未授权。
UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。
UnauthorizedOperation.Unknown 后端服务器发生未知错误。