请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`DescribeStatistics`	要执行的操作，取值：`DescribeStatistics`。
Version	String	是	`2022-03-01`	API 的版本，取值：`2022-03-01`。

Body

参数	类型	是否必填	示例值	描述
InputIdType	String	是	`AcceleratorId`	查询的资源 ID 类型，决定 `InputId` 中传入的是哪类资源的 ID。取值： `AcceleratorId`：按加速器 ID 查询。 `ListenerId`：按监听器 ID 查询。注意基础型加速器仅支持查询加速器维度的监控数据。
InputId	String[]	是	`["accinstance-YfiSM6k5BspFcC4BaG****"]`	待查询的资源 ID 列表，元素类型由 `InputIdType` 决定（加速器 ID 或监听器 ID）。查询加速器时，不能同时包含标准型和基础型加速器的 ID。
Interval	Integer	是	`60`	查询数据的时间粒度，单位为秒。取值： `60`：按照 1 分钟的时间粒度查询，最多允许查看 15 天时间段的监控数据。 `300`：按照 5 分钟的时间粒度查询，最多允许查看 31 天时间段的监控数据。
StartTime	String	是	`2021-01-01 00:00:00`	查询时间段的起始时间。格式为 `yyyy-MM-dd HH:mm:ss`，时区为 GMT+8。您可以查看最近 90 天的指标数据。时间跨度最长为 31 天。
EndTime	String	是	`2021-01-01 23:59:59`	查询时间段的结束时间。格式为 `yyyy-MM-dd HH:mm:ss`，时区为 GMT+8。结束时间不得早于起始时间。
Metrics	String[]	否	`["InboundBandwidth","OutboundBandwidth"]`	查询指标列表。不指定时返回全部指标。取值： `InboundBandwidth`：入方向带宽。 `OutboundBandwidth`：出方向带宽。 `ConnectionNum`：并发连接数，仅标准型加速器支持。 `OutboundTraffic`：出方向流量。 `InboundTraffic`：入方向流量。 `InboundTrafficAccumulation`：入方向累计流量。 `OutboundTrafficAccumulation`：出方向累计流量。
Region	String[]	否	`["CN_North","CN_South"]`	查询的区域列表。不填时，默认查询全部可查询的区域。取值： `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`。其他区域需提交工单申请开通后使用。
GroupByListener	Boolean	否	`false`	是否按监听器对数据进行聚合。取值： `true`：按监听器对数据进行聚合。 `false`（默认值）：汇总所有监听器的数据。当 `GroupByListener` 为 `true` 时，`InputIdType` 必须为 `ListenerId`。
GroupByRegion	Boolean	否	`true`	是否按区域对数据进行聚合。取值： `true`：按区域对数据进行聚合。 `false`（默认值）：汇总所有区域的数据。当 `GroupByRegion` 为 `true` 时，必须通过 `Region` 指定需要返回的区域。
RegionType	String	否	`AccelerateRegion`	选择查看监控指标的维度。取值： `AccelerateRegion`：按加速区域维度查看。 `EndPointGroupRegion`：按终端节点组维度查看。
GroupByAccelerator	Boolean	否	`false`	是否按加速器对数据进行聚合。取值： `true`：按指定加速器聚合数据。 `false`（默认值）：汇总所有加速器的数据。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalStatisticResults	Object[]		在您的筛选条件下，汇总数据信息列表。
Results	Object[]		时间序列组织的查询结果明细。

请求示例

POST https://ga.volcengine-api.com?Action=DescribeStatistics&Version=2022-03-01
{
  "InputIdType": "AcceleratorId",
  "InputId": [
    "accinstance-YfiSM6k5BspFcC4BaG****"
  ],
  "Interval": 60,
  "StartTime": "2021-01-01 00:00:00",
  "EndTime": "2021-01-01 23:59:59",
  "Metrics": [
    "InboundBandwidth"
  ],
  "GroupByListener": false,
  "GroupByRegion": false,
  "RegionType": "AccelerateRegion",
  "GroupByAccelerator": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241119211819128228118093C66BCF",
    "Action": "DescribeStatistics",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "TotalStatisticResults": [
      {
        "MaxBandwidth": 20,
        "MaxBandwidth95": 20,
        "MaxConnectionNum": 10,
        "TotalTraffic": 1048576,
        "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
        "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
        "Region": "CN_North"
      }
    ],
    "Results": [
      {
        "TimeStamp": "2021-01-01 00:00:00",
        "StatisticsResults": [
          {
            "DetailInfo": [
              {
                "Name": "InboundBandwidth",
                "Value": 20
              }
            ],
            "Region": "CN_North",
            "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
            "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****"
          }
        ],
        "TimeStampInt": 1609459200
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParamTimeRange	The supplied time range was invalid.	指定的时间范围无效，请调整起止时间后重试。

最近更新时间：2026.09.23 16:20:54

这个页面对您有帮助吗？

有用

无用

全球加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码