DescWebRespCode-查询 Web 攻击防护响应码信息--DDoS防护-火山引擎

文档中心

立即注册

导航

DescWebRespCode-查询 Web 攻击防护响应码信息

最近更新时间：2024.07.19 19:17:48首次发布时间：2024.07.19 19:17:48

查询指定域名的 Web 攻击防护响应码分布趋势及占比。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=DescWebRespCode&Version=2021-06-15

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescWebRespCode`	接口名称。当前 API 的名称为 `DescWebRespCode`。
Version	String	是	`2021-06-15`	接口版本。当前 API 的版本为 `2021-06-15`。

Body

参数	类型	是否必选	示例值	描述
BeginTime	Integer	否	`1716263580`	起始时间，秒级时间戳，结束时间应大于起始时间。若不填，则默认为一小时前。
EndTime	Integer	否	`1718855580`	结束时间，秒级时间戳，结束时间应大于起始时间。若不填，则默认为当前时刻。
Hosts	Array of String	是	`["www.ddoshost.com"]`	域名列表。
Type	Integer	否	`1`	数据类型，默认为 2 （源站）。 1：按高防实例 IP 2：按源站 IP

返回参数

参数	类型	示例值	描述
Distribution	Array of RespCodeDistrItem	`--`	不同状态码分布情况和占比。
Trend	Array of RespCodeTrendItem	`--`	状态码趋势。

RespCodeDistrItem

参数	类型	示例值	描述
RespCode	String	`200`	状态码。
TotalQps	Float	`2302`	总请求速率。
Percentage	Float	`50`	百分比，展示到小数点后两位。

RespCodeTrendItem

参数	类型	示例值	描述
Flow	Array of RespCodeFlowItem	`--`	该状态码对应的趋势。
RespCode	String	`2XX`	状态码。

RespCodeFlowItem

参数	类型	示例值	描述
Qps	Float	`233`	该时间统计周期内状态码的返回次数。
TimeStamp	Integer	`1716368280`	时间节点，秒级时间戳。

请求示例

POST https://open.volcengineapi.com/?Action=DescWebRespCode&Version=2021-06-15
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
  "Hosts": [
    "www.testddos.com",
  ],
  "BeginTime": 1720419900,
  "EndTime": 1721024700,
  "Type": 2
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240715142521****F2155FC89C006D05",
        "Action": "DescWebRespCode",
        "Version": "2021-06-15",
        "Service": "AdvDefence",
        "Region": "cn-beijng"
    },
    "Result": {
        "Distribution": [
            {
                "RespCode": "2xx",
                "Percentage": 98.25,
                "TotalQps": 5397806
            },
            {
                "RespCode": "3xx",
                "Percentage": 0,
                "TotalQps": 29
            },
            {
                "RespCode": "4xx",
                "Percentage": 1.75,
                "TotalQps": 96080
            }
        ],
        "Trend": [
            {
                "RespCode": "2xx",
                "Flow": [
                    {
                        "TimeStamp": 1720418400,
                        "Qps": 20601
                    },
                    {
                        "TimeStamp": 1720422000,
                        "Qps": 35313
                    }
                    //此处省略若干节点。
                ],
                "Total": 0
            },
            {
                "RespCode": "3xx",
                "Flow": [
                    {
                        "TimeStamp": 1720418400,
                        "Qps": 0
                    },
                    {
                        "TimeStamp": 1720422000,
                        "Qps": 0
                    }
                     //此处省略若干节点。
                ],
                "Total": 0
            },
            {
                "RespCode": "4xx",
                "Flow": [
                    {
                        "TimeStamp": 1720418400,
                        "Qps": 0
                    },
                    {
                        "TimeStamp": 1720422000,
                        "Qps": 0
                    }
                     //此处省略若干节点。
                ],
                "Total": 0
            }
        ]
    }
}