获取回源状态码的统计排名--内容分发网络-火山引擎

文档中心

立即注册

导航

获取回源状态码的统计排名

最近更新时间：2024.04.16 14:45:14首次发布时间：2022.03.23 11:27:09

说明

我们全新设计了数据统计 API。推荐您使用新版 API。

基于指定的时间段，对一个或多个域名统计源站响应状态码的数量并排序。该 API 支持排序的状态码分类维度如下：

status_2xx：根据 2xx 汇总结果排序，2xx 汇总结果表示访问状态码为 200-299 的总个数。
status_3xx：根据 3xx 汇总结果排序，3xx 汇总结果表示访问状态码为 300-399 的总个数。
status_4xx：根据 4xx 汇总结果排序，4xx 汇总结果表示访问状态码为 400-499 的总个数。
status_5xx：根据 5xx 汇总结果排序，5xx 汇总结果表示访问状态码为 500-599 的总个数。

数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。

使用限制

节流限制：您每秒最多可以发送 20 个 API 请求。

时间限制：系统保留最近 92 天的访问数据。您不能查询 92 天以前的访问数据。

数据延迟：访问数据延迟约为 5 分钟。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeOriginTopStatusCode&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeOriginTopStatusCode`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	Long	是	指定一个开始时间。时间格式是 Unix 时间戳，精度是秒。`StartTime` 必须早于或者等于 `EndTime`。您必须同时指定 `StartTime` 和 `EndTime`，或者都不指定。如果您不指定这 2 个参数，默认统计最近 24 小时的数据。	`1641844915`
EndTime	Long	是	指定一个结束时间。时间格式是 Unix 时间戳，精度是秒。	`1641845373`
Domain	String	否	指定一个或多个加速域名。最多可指定 50 个加速域名。基于所有域名的汇总数据，对指标数据进行统计排序。多个加速域名使用逗号`（,）`分隔。逗号后面不能加空格。如果不指定该参数，则包含账号下的所有域名。子账号调用说明：如果是子账号调用该 API，需要注意以下几点：子账号指定了 Domain 参数。但是在指定的加速域名中存在该子账号无权限访问的域名。此时 API 调用会失败并且报`您没有权限执行该操作`错误。子账号未指定 Domain 参数。此时则包含该子账号有权限访问的所有域名。关于更多子账号权限信息，参考权限管理概述。	`www.example.com`
Item	String	是	指定一个排序维度。该参数的可用值是如下： `domain`：统计各域名的指标数据并排序。	`domain`
Metric	String	是	指定一个指标作为排序依据。排序是按照数据从大到小排列的。该参数的可用值如下：- `status_2xx`：根据 2xx 汇总结果排序，2xx 汇总结果表示回源状态码为 200-299 的总个数。 `status_3xx`：根据 3xx 汇总结果排序，3xx 汇总结果表示回源状态码为 300-399 的总个数。 `status_4xx`：根据 4xx 汇总结果排序，4xx 汇总结果表示回源状态码为 400-499 的总个数。 `status_5xx`：根据 5xx 汇总结果排序，5xx 汇总结果表示回源状态码为 500-599 的总个数。	`status_5xx`

响应正文

参数名称	数据类型	参数说明	示例
Item	String	表示统计的排序维度。	`domain`
Metric	String	表示统计的指标。包含所有指标。	`status5xx`
Name	String	表示指定统计的所有域名。未指定域名时为空，返回的是全部域名的数据，如果域名无回源数据时，则不返回对应域名的情况	`www.a.com,www.b.com`
TopDataDetails	Object[]	表示一个或多个的统计数据对象。按指标数据从大到小排序。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeOriginTopStatusCode&Version=2021-03-01
{
    "StartTime": 1641263400,
    "EndTime": 1641265200,
    "Metric": "status_2xx",
    "Domain":"www.example.com,www.example2.com",
    "Item":"domain"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220105181801010211175223230002B9",
        "Action": "DescribeOriginTopStatusCode",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Item": "domain", 
        "Metric": "status_2xx", //status_2xx/status_3xx/status_4xx/status_5xx
        "Name": "www.example.com,www.example2.com",
        "TopDataDetails": [
            {
                "ItemKey": "www.example.com",
                "2xx": 5,
                "2xxRatio": 0.7142857142857143,
                "3xx": 0,
                "3xxRatio": 0,
                "4xx": 2,
                "4xxRatio": 0.2857142857142857,
                "5xx": 0,
                "5xxRatio": 0
            },
            {
                "ItemKey": "www.example.com",
                 "2xx": 0,
                "2xxRatio": 0,
                "3xx": 0,
                "3xxRatio": 0,
                "4xx": 0,
                "4xxRatio": 0,
                "5xx": 0,
                "5xxRatio": 0
            }
        ]
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。