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

1. 接口描述

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

DescribeScdnConfig 用于查询指定 SCDN 加速域名的安全相关配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeScdnConfig。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Domain String 域名
示例值:www.test.com

3. 输出参数

参数名称 类型 描述
Acl ScdnAclConfig 自定义防护策略配置
Waf ScdnWafConfig Web 攻击防护(WAF)配置
CC ScdnConfig CC 防护配置
Ddos ScdnDdosConfig DDOS 防护配置
Bot ScdnBotConfig BOT 防护配置
Status String 当前状态,取值online | offline
注意:此字段可能返回 null,表示取不到有效值。
示例值:online
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询SCDN域名配置

查询SCDN域名配置

输入示例

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

{
    "Domain": "www.test.com"
}

输出示例

{
    "Response": {
        "CC": {
            "Rules": [
                {
                    "FrequencyLimit": 1,
                    "RuleType": "file",
                    "DetectionTime": 1,
                    "RuleValue": [
                        "html"
                    ],
                    "PunishmentTime": 1,
                    "RedirectUrl": "https://test.com/redirect",
                    "Action": "redirect",
                    "Qps": 1,
                    "PunishmentSwitch": "on"
                }
            ],
            "Switch": "on"
        },
        "Waf": {
            "Rules": [
                {
                    "Operate": "observe",
                    "AttackType": "xss"
                }
            ],
            "WebShellSwitch": "on",
            "Switch": "on",
            "ErrorPage": {
                "RedirectUrl": "https://test.com/redirect",
                "RedirectCode": 302
            },
            "Mode": "observe"
        },
        "Bot": {
            "Switch": "on",
            "BotJavaScript": [
                {
                    "RuleType": "file",
                    "RuleValue": [
                        "html"
                    ],
                    "UpdateTime": "2020-09-22 00:00:00",
                    "RedirectUrl": "https://test.com/redirect",
                    "Switch": "on",
                    "Action": "monitor"
                }
            ],
            "BotCookie": [
                {
                    "RuleType": "all",
                    "RuleValue": [
                        "*"
                    ],
                    "UpdateTime": "2020-09-22 00:00:00",
                    "RedirectUrl": "https://test.com/redirect",
                    "Switch": "on",
                    "Action": "monitor"
                }
            ]
        },
        "Acl": {
            "Switch": "on",
            "ScriptData": [
                {
                    "Status": "active",
                    "Configure": [
                        {
                            "MatchKey": "ip",
                            "MatchValue": "10.0.0.1",
                            "LogiOperator": "include"
                        }
                    ],
                    "Result": "intercept",
                    "RuleName": "rule1"
                }
            ],
            "ErrorPage": {
                "RedirectUrl": "https://test.com/redirect",
                "RedirectCode": 301
            }
        },
        "Status": "online",
        "Ddos": {
            "Switch": "on"
        },
        "RequestId": "1abbe623-4b0e-4727-ab51-7624902d47f4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnHostNotExists 未查询到该域名,请确认域名是否正确。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。