查询回源实时监控数据 DescribeOriginRealtimeData--全站加速-火山引擎

文档中心

全站加速

数据监控接口

查询回源实时监控数据 DescribeOriginRealtimeData

查询回源实时监控数据。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DescribeOriginRealtimeData&Version=2021-04-01

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	String	是	查询起始时间。您可以查询到7天以内的数据。查询时间跨度（StartTime和EndTime之间时长）不能超过24小时。	`2021-01-01 00:00:00`
EndTime	String	是	查询结束时间，结束时间大于起始时间。	`2021-01-01 23:59:59`
Domains	String[]	否	指定域名列表，为空时表示查询当前用户所有域名。	`["www.example.com","cdn.example.com"]`
Metrics	String[]	是	指定返回的监控指标，支持取值： `all`：全部指标。 `traffic`：流量，单位为 byte。 `bandwidth`：峰值带宽，单位为 bps。 `request`：请求数。 `QPS`：峰值QPS。 `2xx`：返回 2xx 状态码的请求数。返回结果会提供 2xx 状态码总请求数以及单个 2xx 状态码的总请求数。 `3xx`：返回 3xx 状态码的请求数。返回结果会提供 3xx 状态码总请求数以及单个 3xx 状态码的总请求数。 `4xx`：返回 4xx 状态码的请求数。返回结果会提供 4xx 状态码总请求数以及单个 4xx 状态码的总请求数。 `5xx`：返回 5xx 状态码的请求数。返回结果会提供 5xx 状态码总请求数以及单个 5xx 状态码的总请求数。	`["bandwidth","traffic","5xx"]`
Protocol	String[]	否	指定回源请求的应用层协议，为空时表示查询所有协议，支持取值： `ALL`：所有协议 `HTTP` `HTTPS`	`HTTPS`
Type	String	否	指定访问请求类型，不填时表示查询所有类型（相当于all）。支持取值： `all`：所有类型。 `dynamic`：仅查询动态请求对应指标。 `static`：仅查询静态请求对应指标。	`all`
IPVersion	String	否	指定IP协议类型查询。不填时表示查询所有类型，支持取值： `all`：所有类型。 `ipv4`：通过 IPv4 访问DCDN的请求 `ipv6`：通过 IPv6 访问DCDN的请求	`ipv4`
ProjectName	String[]	否	指定域名所属的项目，为空时表示查询当前用户所有项目。	`["test"]`

返回参数

参数名称	数据类型	参数说明	示例
DomainCount	Integer	查询域名中有效域名的数量。	`10`
StartTime	String	查询起始时间。	`2021-01-01 00:00:00`
EndTime	String	查询结束时间。	`2021-01-01 23:59:59`
Metrics	String[]	回显查询时选择展示的统计指标。	`["all"]`
Results	Object[]	以一分钟为颗粒度的样本集合，集合中每个对象对应一分钟时长的统计数据。

请求示例

POST https://open.volcengineapi.com?Action=DescribeOriginRealtimeData&Version=2021-04-01
{
    "StartTime": "2021-12-02 16:39:49",
    "EndTime": "2021-12-02 16:41:49",
    "Domains": [
        "www.example.com",
        "dcdn.example.com"
    ],
    "Metrics": [
        "all"
    ],
    "Type": "dynamic"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021122211521201022513314303D1BC12",
        "Action": "DescribeOriginRealtimeData",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainCount": 2,
        "StartTime": "2021-12-02 16:39:49",
        "EndTime": "2021-12-02 16:41:49",
        "Metrics": [
            "all"
        ],
        "Results": [
            {
                "TimeStamp": "2021-12-02 16:40:00",
                "RealTimeResults": [
                    {
                        "DomainName": "www.example.com",
                        "DetailInfo": [
                            {
                                "Name": "Traffic",
                                "Value": 6128.1
                            },
                            {
                                "Name": "Request",
                                "Value": 13
                            },
                            {
                                "Name": "QPS",
                                "Value": 0.21
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 816.2
                            }
                        ]
                    },
                    {
                        "DomainName": "dcdn.example.com",
                        "DetailInfo": [
                            {
                                "Name": "Traffic",
                                "Value": 2755.5
                            },
                            {
                                "Name": "Request",
                                "Value": 4
                            },
                            {
                                "Name": "QPS",
                                "Value": 0.067
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 367.4
                            }
                        ]
                    }
                ]
            },
            {
                "TimeStamp": "2021-12-02 16:41:00",
                "RealTimeResults": [
                    {
                        "DomainName": "www.example.com",
                        "DetailInfo": [
                            {
                                "Name": "Traffic",
                                "Value": 4455
                            },
                            {
                                "Name": "Request",
                                "Value": 14
                            },
                            {
                                "Name": "QPS",
                                "Value": 0.23
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 594
                            }
                        ]
                    },
                    {
                        "DomainName": "dcdn.example.com",
                        "DetailInfo": [
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

最近更新时间：2026.05.25 16:53:18

这个页面对您有帮助吗？

有用

无用

全站加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

请求说明

请求参数

Query

Body

返回参数

请求示例

返回示例