查询访问监控数据 DescribeStatistics--全站加速-火山引擎

文档中心

全站加速

数据监控接口

查询访问监控数据 DescribeStatistics

查询客户端访问视角的监控统计数据。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	String	是	查询起始时间。您可以查询过去90天内的数据。查询时间跨度（StartTime和EndTime之间时长）不能超过31天。基于您指定的时间跨度，您可以选择数据样本的时间粒度（`Interval` 参数）会相应不同。	`2021-01-01 00:00:00`
EndTime	String	是	查询结束时间，结束时间大于起始时间。	`2021-01-01 23:59:59`
Metrics	String[]	否	指定返回的监控指标，支持取值： `all`：全部指标。 `traffic`：流量，单位为 byte。 `bandwidth`：峰值带宽，单位为 bps。 `request`：请求数。 `QPS`：峰值QPS。 `RequestHitRate`：请求数命中率。 `TrafficHitRate`：流量命中率。 `2xx`：返回 2xx 状态码的请求数。返回结果会提供 2xx 状态码总请求数以及单个 2xx 状态码的总请求数。 `3xx`：返回 3xx 状态码的请求数。返回结果会提供 3xx 状态码总请求数以及单个 3xx 状态码的总请求数。 `4xx`：返回 4xx 状态码的请求数。返回结果会提供 4xx 状态码总请求数以及单个 4xx 状态码的总请求数。 `5xx`：返回 5xx 状态码的请求数。返回结果会提供 5xx 状态码总请求数以及单个 5xx 状态码的总请求数。	`["bandwidth","traffic","5xx"]`
Domains	String[]	是	指定查询域名列表。为空时代表查询当前用户所有域名。	`["example.com"]`
Interval	Integer	否	时间样本粒度，单位为秒。支持取值：查询时间段跨度 3 天以内（不含3）：支持 `300`、`3600`、 `86400`。不传该参数时，默认值为`300`。查询时间段跨度 3 - 31 天（不含31）：支持 `3600` 和 `86400`。不传该参数时，默认值为 `3600`。查询时间段跨度 31 天：支持 `86400`。不传该参数，默认值为 `86400`。	`300`
Protocol	String[]	否	指定客户端请求应用层和传输层协议查询，为空时表示查询所有协议，支持取值： `ALL`：全部协议 `HTTP`：HTTP协议 `HTTPS`：HTTPS协议 `QUIC`：QUIC协议 `WS`：WebSocket协议	`["HTTP","HTTPS"]`
Area	String	否	客户端所在区域，不填表示查询所有区域，支持参数： `China`：中国大陆； `Global`：全球。	`China`
Region	String[]	否	指定客户端所在详细区域，为空时表示查询所有区域。当 `Area` 为 `China` 或 `Global` 时，`Region` 支持的区域详见下方表格。	`["HA","HB"]`
ProjectName	String[]	否	指定域名所属的项目，为空时表示查询当前用户所有项目。	`["test"]`
IspNameEn	String[]	否	指定运营商，为空时表示查询所有运营商，支持的运营商如下所示。 `unicom`：中国联通； `telecom`：中国电信； `mobile`：中国移动； `guangdian`：广电； `edu`：教育网； `tietong`：铁通； `pengboshi`：鹏博士； `other`：其他运营商。	`["telecom"]`
AcceleratingRegion	String	否	指定加速区域，为空时表示查询所有区域，支持取值： `CHN`：中国内地 `EU`（仅对开通此功能的客户可见）：欧洲 `NA`（仅对开通此功能的客户可见）：北美 `SA`（仅对开通此功能的客户可见）：南美 `ME`（仅对开通此功能的客户可见）：中东 `AP1`（仅对开通此功能的客户可见）：亚太1 `AP2`（仅对开通此功能的客户可见）：亚太2 `AP3`（仅对开通此功能的客户可见）：亚太3	`CHN`
AcceleratingScope	String	否	指定加速区域范围，为空时表示查询全球范围，支持取值： `mainland`：中国内地。 `overseas`：海外（中国内地以外区域）	`mainland`
Type	String	否	指定访问请求类型，为空时表示查询所有类型（相当于`all`）。支持取值： `all`：所有类型。 `dynamic`：仅查询动态请求对应指标。 `static`：仅查询静态请求对应指标。	`all`
IPVersion	String	否	指定IP协议类型查询。不填时表示查询所有类型，支持取值： `all`：所有类型。 `ipv4`：通过 IPv4 访问DCDN的请求 `ipv6`：通过 IPv6 访问DCDN的请求	`ipv4`

Area 取值	对应 Region 的取值范围
China	["BJ", "AH", "CQ", "FJ", "GD", "GS", "GX", "GZ", "HA", "HB", "HE", "HI", "HK", "HL", "HN", "JL", "JS", "JX", "LN", "MO", "NM", "NX", "QH", "SC", "SD", "SH", "SN", "SX", "TJ", "TW", "XJ", "XZ", "YN", "ZJ", "OTHERS"]
Global	["CHN", "CHE", "AZE", "PNG", "PSE", "FSM", "LVA", "KHM", "SPM", "MYS", "COG", "VNM", "GRD", "HND", "GUF", "WLF", "COK", "BFA", "LAO", "IOT", "SVK", "GUM", "MLI", "RWA", "SGS", "IRN", "BLR", "KEN", "SMR", "BVT", "MSR", "DOM", "GIN", "IMN", "BLZ", "NRU", "NFK", "TZA", "BHR", "LBY", "YEM", "ARE", "SXM", "CPV", "MKD", "HMD", "ZWE", "ESP", "ATG", "BGD", "TKM", "MYT", "IND", "GRC", "SAU", "PHL", "GHA", "ISR", "VGB", "JAM", "TON", "DNK", "TCA", "LBR", "NLD", "PAN", "VCT", "COM", "PYF", "SWE", "CRI", "GTM", "KNA", "TUV", "PAK", "TJK", "DZA", "FIN", "MHL", "SLV", "FJI", "PER", "WSM", "CAF", "ERI", "LSO", "GGY", "MAR", "CYP", "ISL", "GNB", "NOR", "IRQ", "VUT", "AND", "CXR", "JOR", "MEX", "MCO", "NER", "JPN", "FRA", "EST", "VEN", "UMI", "AUS", "PRT", "GIB", "LIE", "ALB", "KOR", "HRV", "MNE", "TUN", "QAT", "SGP", "COL", "CUB", "EGY", "ARG", "CHL", "LCA", "ZAF", "CCK", "NPL", "MTQ", "ATF", "THA", "SRB", "ETH", "SJM", "BDI", "PRK", "GNQ", "BMU", "UKR", "OMN", "SDN", "ZMB", "DEU", "MDG", "AIA", "GUY", "NIC", "GRL", "MMR", "LKA", "BEL", "PRY", "PRI", "MLT", "MNP", "IRL", "ABW", "CYM", "TCD", "CIV", "BRB", "ALA", "BGR", "HTI", "NIU", "COD", "DJI", "TGO", "ASM", "BIH", "KWT", "MWI", "MNG", "SYR", "KAZ", "BEN", "SHN", "UGA", "KIR", "SLE", "AFG", "UZB", "SEN", "REU", "TUR", "URY", "TTO", "NAM", "ITA", "BOL", "PCN", "BWA", "MDV", "VAT", "SSD", "CZE", "MUS", "SOM", "XKS", "SUR", "GBR", "BRA", "JEY", "ECU", "FLK", "NCL", "AGO", "MOZ", "POL", "PLW", "IDN", "SLB", "GMB", "LBN", "MAF", "BHS", "USA", "ARM", "GLP", "BTN", "CUW", "ESH", "ROU", "GEO", "NGA", "LTU", "VIR", "SYC", "ATA", "RUS", "TKL", "GAB", "CAN", "BRN", "STP", "NZL", "CMR", "SWZ", "TLS", "SVN", "LUX", "MDA", "HUN", "FRO", "MRT", "BLM", "AUT", "KGZ", "OTHERS"]
为空	全部区域

返回参数

参数名称	数据类型	参数说明	示例
DomainCount	Integer	查询域名中有效域名的数量。	`20`
StartTime	String	查询起始时间。	`2021-01-01 00:00:00`
EndTime	String	查询结束时间。	`2021-01-01 23:59:59`
Metrics	String[]	回显查询时选择展示的统计指标。	`["bandwidth"]`
Results	Object[]	统计指标的明细。基于请求中`Interval`参数指定的时间样本粒度，以时间序列结构展示。

请求示例

POST https://open.volcengineapi.com?Action=DescribeStatistics&Version=2021-04-01
{
    "StartTime": "2025-03-15 00:00:00",
    "EndTime": "2025-03-15 00:10:00",
    "Metrics": [
        "traffic",
        "request",
        "QPS",
        "4xx",
        "5xx"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250611104840DCFAE2A3F73B54923DB1",
        "Action": "DescribeStatistics",
        "Version": "2021-04-01",
        "Service": "DCDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "DomainCount": 78,
        "StartTime": "2025-03-15 00:00:00",
        "EndTime": "2025-03-15 00:10:00",
        "Metrics": [
            "traffic",
            "request",
            "QPS",
            "4xx",
            "5xx"
        ],
        "Results": [
            {
                "TimeStamp": "2025-03-15 00:00:00",
                "DetailInfo": [
                    {
                        "Name": "Traffic",
                        "Value": 982447
                    },
                    {
                        "Name": "Request",
                        "Value": 102
                    },
                    {
                        "Name": "QPS",
                        "Value": 0.33999999999999997
                    },
                    {
                        "Name": "4xx",
                        "Value": 0
                    },
                    {
                        "Name": "400",
                        "Value": 0
                    },
                    {
                        "Name": "403",
                        "Value": 0
                    },
                    {
                        "Name": "404",
                        "Value": 0
                    },
                    {
                        "Name": "499",
                        "Value": 0
                    },
                    {
                        "Name": "401",
                        "Value": 0
                    },
                    {
                        "Name": "5xx",
                        "Value": 0
                    },
                    {
                        "Name": "500",
                        "Value": 0
                    },
                    {
                        "Name": "502",
                        "Value": 0
                    },
                    {
                        "Name": "533",
                        "Value": 0
                    },
                    {
                        "Name": "504",
                        "Value": 0
                    },
                    {
                        "Name": "505",
                        "Value": 0
                    },
                    {
                        "Name": "530",
                        "Value": 0
                    },
                    {
                        "Name": "531",
                        "Value": 0
                    },
                    {
                        "Name": "532",
                        "Value": 0
                    }
                ]
            },
            {
                "TimeStamp": "2025-03-15 00:05:00",
                "DetailInfo": [
                    {
                        "Name": "Traffic",
                        "Value": 255638
                    },
                    {
                        "Name": "Request",
                        "Value": 101
                    },
                    {
                        "Name": "QPS",
                        "Value": 0.33666666666666667
                    },
                    {
                        "Name": "4xx",
                        "Value": 1
                    },
                    {
                        "Name": "400",
                        "Value": 0
                    },
                    {
                        "Name": "403",
                        "Value": 0
                    },
                    {
                        "Name": "404",
                        "Value": 1
                    },
                    {
                        "Name": "499",
                        "Value": 0
                    },
                    {
                        "Name": "401",
                        "Value": 0
                    },
                    {
                        "Name": "5xx",
                        "Value": 0
                    },
                    {
                        "Name": "500",
                        "Value": 0
                    },
                    {
                        "Name": "502",
                        "Value": 0
                    },
                    {
                        "Name": "533",
                        "Value": 0
                    },
                    {
                        "Name": "504",
                        "Value": 0
                    },
                    {
                        "Name": "505",
                        "Value": 0
                    },
                    {
                        "Name": "530",
                        "Value": 0
                    },
                    {
                        "Name": "531",
                        "Value": 0
                    },
                    {
                        "Name": "532",
                        "Value": 0
                    }
                ]
            }
        ],
        "TotalStatistics": {
            "4xx": 1,
            "4xxRatio": 0.0049261083743842365,
            "5xx": 0,
            "5xxRatio": 0,
            "QPS": 0.33999999999999997,
            "Request": 203,
            "Traffic": 1238085
        }
    }
}

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

这个页面对您有帮助吗？

有用

无用

全站加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

请求说明

请求参数

Query

Body

返回参数

请求示例

返回示例