You need to enable JavaScript to run this app.
导航

DescribeStatistics

最近更新时间2024.04.11 17:57:13

首次发布时间2022.09.01 11:30:07

API说明

API 名称:DescribeStatistics。
API 域名:open.volcengineapi.com 。
API 描述:查询四层加速域名。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

参数类型是否必选参数说明示例

InputIdType

string

查询时使用 ID 的类型,取值包括:

  • AcceleratorId:加速器 ID。
  • ListenerId:监听器 ID 。

AcceleratorId

InputIdlist of string查询时输入的 ID 。accinstance-rhB2dKMFtyVaWLUikXUwx3

Metrics

list of string

获取信息的类型。支持取值:

  • ConnectionNum:连接数。
  • ALL:查询所有信息。

ALL

StartTime

string

查询起始时间,起始时间最早为前90天。

2019-12-13 00:00:00

EndTime

string

查询结束时间,结束时间需大于起始时间,查看跨度最大为30天。

2019-12-13 23:59:59

Interval

int

时间粒度,单位为秒。支持时间粒度如下:

  • 60秒(1分钟):最长可查看15天的数据。
  • 300秒(5分钟):最长可查看31天的数据。

1分钟

Regionlist of string查询指定地域,取值包括:东北、华东、华南、华北、西北、西南、华中,设置为空时表示查询所有地域。东北

响应正文

参数类型参数说明示例
TimeStamp
string
字段名称。
2022-03-18 11:49:07
DetailInfoarray of DetailInfo字段类型。DetailInfo

DetailInfo

参数类型参数说明示例
Name
string
数据的解释,支持取值: - ConnectionNum:连接数。
ConnectionNum
ValueFloat此数据的值。1

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=DescribeStatistics&<其他公共请求参数>
{
    "StartTime":"2021-12-12 12:48:49",
    "EndTime":"2021-12-12 12:49:49",
    "InputId":["accinstance-rhB2dKMFtyVaWLUikXUwx3"],
    "Metrics":["ALL"],
    "InputIdType":"AcceleratorId",
    "Region":["华中"],
    "Interval":300
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20220319002758010225133143063F9B0C",
        "Action": "DescribeStatistics",
        "Version": "2022-03-01",
        "Service": "ga_mashuo",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "TimeStamp": "2022-03-18 11:49:07",
            "DetailInfo": [
                {
                    "Name": "InboundBandwidth",
                    "Value": 7
                },
                {
                    "Name": "OutboundBandwidth",
                    "Value": 7
                },
                {
                    "Name": "ConnectionNum",
                    "Value": 7
                }
            ]
        },
        {
            "TimeStamp": "2022-03-18 11:49:07",
            "DetailInfo": [
                {
                    "Name": "InboundBandwidth",
                    "Value": 7
                },
                {
                    "Name": "OutboundBandwidth",
                    "Value": 7
                },
                {
                    "Name": "ConnectionNum",
                    "Value": 7
                }
            ]
        }
    ]
}