查询回源资源用量--全站加速-火山引擎

文档中心

立即注册

导航

查询回源资源用量

最近更新时间：2023.10.26 11:48:58首次发布时间：2021.12.27 17:16:07

API说明

API名称：DescribeOriginStatistics 。
API域名：open.volcengineapi.com。
API描述：查询域名的回源资源用量数据。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称	是否必选	参数类型	参数说明
Action	是	String	API 名称，该参数的取值是 DescribeOriginStatistics 。
Version	是	String	API 版本，该参数的取值是 2021-04-01 。

请求正文

参数名称	是否必选	参数类型	参数说明	示例
StartTime	是	String	查询起始时间。	`2021-01-01 00:00:00`
EndTime	是	String	查询结束时间，结束时间大于起始时间。	`2021-01-01 23:59:59`
Domains	是	[ ]String	指定查询域名列表，为空代表查询当前用户所有域名。	`[www.bytedance.com]`
Metrics	是	[ ]String	指定查询指标，支持取值： all：全部指标。 traffic：流量，单位为 byte 。 bandwidth：峰值带宽，单位为 bps 。 request: 请求数，单位为次。 QPS: 峰值QPS，单位为次/s 。 2xx：返回 2xx 状态码汇总或者 2 开头状态码数据，单位为个。 3xx：返回 3xx 状态码汇总或者 3 开头状态码数据，单位为个。 4xx：返回 4xx 状态码汇总或者 4 开头状态码数据，单位为个。 5xx：返回 5xx 状态码汇总或者 5 开头状态码数据，单位为个。	`[bandwidth,2xx]`
Interval	否	Integer	时间粒度，单位为秒，支持参数： 3 天以内（不含3）：支持 300、3600、 86400，不传该参数时，默认值为300。 3 - 31 天（不含31）：支持 3600 和 86400，不传该参数时，默认值为3600。 31 天及以上：支持 86400，不传该参数，默认值为 86400。	`300`
Protocol	否	[ ]String	指定客户端请求应用层和传输层协议查询，为空时表示查询所有协议，支持参数： ALL HTTP HTTPS	`[HTTP,HTTPS]`
Type	否	String	指定访问类型，不填时表示查询所有类型，返回总和（相当于all），支持参数： all：所有类型。 dynamic：指定查询动态内容对应指标。 static：指定查询静态内容对应指标。	`all`
IPVersion	否	String	指定ip类型查询，不填时表示查询所有类型，支持参数： all：所有类型。 ipv4 ipv6	`all`

注意

资源用量和实时监控接口的查询时间区别如下表。

具体指标	资源用量	实时监控
查询时支持查到的最早历史数据	90天前	7天前
查询时支持最大的查询时间跨度	31天	24小时
查询后数据展示的最小时间粒度	5分钟（可修改其他更大数值）	1分钟（不可修改）

响应正文

参数名称	参数类型	参数说明	示例
RequestId	String	请求ID。	`2021121*****58010225133143064747B5`
DomainCount	Integer	查询域名中有效域名的数量。	`20`
StartTime	String	查询起始时间。	`2021-01-01 00:00:00`
EndTime	String	查询结束时间。	`2021-01-01 23:59:59`
Metrics	[ ]String	查询时选择展示的字段。	`["bandwidth","2xx"]`
Results	Result	查询数据明细。	`-`
TotalStatistics	TotalStatistics	查询数据汇总。	`-`

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeOriginStatistics&<其他公共请求参数>
{
    "StartTime": "2021-12-02 16:39:49",
    "EndTime": "2021-12-02 16:49:49",
    "Domains": ["www.bytedance.com"],
    "Metrics": ["all"],
    "Interval": 300,
    "Type": "dynamic",
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2021122211521201022513314303D1BC12",
        "Action": "DescribeOriginStatistics",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
   "Result": {
        "DomainCount": 1,
        "StartTime": "2021-12-02 16:39:49",
        "EndTime": "2021-12-02 16:49:49",
        "Metrics": [
            "all"
        ],
        "Results": [
            {
                "TimeStamp": "2021-12-02 16:40:00",
                "DetailInfo": [
                    {
                        "Name": "Traffic",
                        "Value": 28135.8
                    },
                    {
                        "Name": "Request",
                        "Value": 72
                    },
                    {
                        "Name": "QPS",
                        "Value": 0.24
                    },
                    {
                        "Name": "Bandwidth",
                        "Value": 749.98
                    }
                ]
            },
            {
                "TimeStamp": "2021-12-02 16:45:00",
                "DetailInfo": [
                    {
                        "Name": "Traffic",
                        "Value": 30600.9
                    },
                    {
                        "Name": "Request",
                        "Value": 73
                    },
                    {
                        "Name": "QPS",
                        "Value": 0.24
                    },
                    {
                        "Name": "Bandwidth",
                        "Value": 815.54
                    }
                ]
            }
        ],
        "TotalStatistics": {
            "Bandwidth": 815.54,
            "QPS": 0.24,
            "Request": 145,
            "Traffic": 58736.7,
        }
    }
}