查询全球加速监控数据DescribeStatistics--全球加速-火山引擎

文档中心

立即注册

导航

查询全球加速监控数据DescribeStatistics

最近更新时间：2024.09.30 14:36:07首次发布时间：2024.09.30 14:36:07

本接口用于查询全球加速的监控数据。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
InputIdType	String	是	查询数据类型，支持参数： AcceleratorId：加速器ID，表示查询加速器维度的监控数据。 ListenerId：监听ID，表示查询监听维度的监控数据。注意基础型加速器只具备加速器维度的数据监控。	`AcceleratorId`
InputId	String[]	是	查询数据的 ID 列表。默认对本账号下的加速器或监听全选。	`["accinstance-xxx"]`
Interval	Integer	是	查询数据的时间粒度，单位：秒，支持参数： 60：表示按照1分钟的时间粒度进行查询。1分钟粒度最多允许查看15天时间段的监控数据。 300：表示按照5分钟的时间粒度进行查询。5分钟粒度最多允许查看31天时间段的监控数据。	`60`
StartTime	String	是	查询的起始时间，起始时间不晚于结束时间。	`2021-01-01 00:00:00`
EndTime	String	是	查询的结束时间，结束时间不早于起始时间。	`2021-01-01 23:59:59`
GroupByRegion	Boolean	否	是否按区域对数据进行聚合处理。 true：按区域对数据进行聚合处理。 false（默认值）：不进行聚合处理。	`false`
RegionType	String	是	您可以选择`加速区域`或`终端节点组`来查看监控的数据指标的信息。 AccelerateRegion：表示选择加速区域维度来查看监控的数据指标。 EndPointGroupRegion：表示选择终端节点组来维度查看监控的数据指标。	`AccelerateRegion`
Region	String[]	否	查询的区域列表。不填时，默认查询全部可查询的区域。 CN_North：华北 CN_East：华东 CN_South：华南 CN_NorthEast：东北 CN_Central：华中 CN_NorthWest：西北 CN_SouthWest：西南 AP1：亚太1 注意对于非白名单用户：标准型加速器的可查询的加速区域为：CN_North、CN_East、CN_South、AP1。基础型加速器的可查询的加速区域为：CN_South、AP1。	`["CN_South"]`

返回参数

参数名称	数据类型	参数说明	示例
Results	Object[]	在您的筛选条件下，对应的查询结果列表。	`-`
TotalStatisticResults	Object[]	在您的筛选条件下，汇总数据信息列表。	`-`

请求示例

POST https://open.volcengineapi.com?Action=DescribeStatistics&Version=2022-03-01
{
    "InputIdType": "AcceleratorId",
    "RegionType": "AccelerateRegion",
    "GroupByRegion": false,
    "Interval": 300,
    "InputId": [
        "accinstance-xxx"
    ],
    "StartTime": "2021-01-01 00:00:00",
    "EndTime": "2021-01-01 00:00:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240927173801EC311973CE3C3B0F6EBA",
        "Action": "DescribeStatistics",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "Results": [
            {
                "TimeStamp": "2024-01-01 00:00:00",
                "StatisticsResults": [
                    {
                        "DetailInfo": [
                            {
                                "Name": "InboundBandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "OutboundBandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "ConnectionNum",
                                "Value": 0
                            },
                            {
                                "Name": "OutboundTraffic",
                                "Value": 0
                            },
                            {
                                "Name": "InboundTraffic",
                                "Value": 0
                            },
                            {
                                "Name": "OutboundPacketLossRate",
                                "Value": 0
                            },
                            {
                                "Name": "InboundPacketLossRate",
                                "Value": 0
                            },
                            {
                                "Name": "InboundTrafficAccumulation",
                                "Value": 0
                            },
                            {
                                "Name": "OutboundTrafficAccumulation",
                                "Value": 0
                            },
                            {
                                "Name": "OutboundPacketLossRateCRB",
                                "Value": 0
                            },
                            {
                                "Name": "InboundPacketLossRateCRB",
                                "Value": 0
                            }
                        ]
                    }
                ]
            }
        ],
        "TotalStatisticResults": [
            {
                "TotalTraffic": 0,
                "MaxConnectionNum": 0,
                "MaxBandwidth": 0,
                "MaxBandwidth95": 0
            }
        ]
    }
}