查询WebSocket连接数用量DescribeWSStatistics--全站加速-火山引擎

文档中心

立即注册

导航

查询WebSocket连接数用量DescribeWSStatistics

最近更新时间：2024.08.16 17:40:48首次发布时间：2024.08.16 15:22:03

API说明

API名称：DescribeWSStatistics。
API域名：open.volcengineapi.com。
API描述：查询 WebSocket 连接数用量。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	String	是	指定查询的开始时间。开始时间和结束时间最大查询跨度不超过31天。	`2024-08-12 00:00:00`
EndTime	String	是	指定查询的结束时间。开始时间和结束时间最大查询跨度不超过31天。	`2024-08-12 00:18:36`
ProjectName	String[]	否	按照项目的维度查询 WebSocket 连接数情况，您可指定一个或多个项目。不指定项目时，默认查询账号下所有项目的数据。	`["TEST"]`
Interval	Integer	否	指定查询的时间粒度，单位是秒。支持取值: 60（1分钟）：查询的时间粒度为1分钟，仅查询开始时间与结束时间的时间跨度在1天内时，才允许设置查询的时间粒度为1分钟。 300（5分钟）：查询的时间粒度为5分钟，默认的时间粒度。 3600（1小时）：查询的时间粒度为1小时。 86400（1天）：查询的时间粒度为1天。	`300`
GroupByDomain	Boolean	否	WebSocket 连接数情况是否根据域名分组。 true：WebSocket 连接数情况会按照域名维度分组返回。 false：WebSocket 连接数情况不分组。	`true`
Domains	String[]	否	按照域名的维度查询 WebSocket 连接数情况，您可指定一个或多个加速域名。不指定域名时，默认查询账号下所有域名的数据。	`["www.test.com"]`

返回参数

参数名称	数据类型	参数说明	示例
Domains	String[]	您查询的域名。	`["www.test.com"]`
Results	Object[]	WebSocket 连接数用量详情。	`-`

请求示例

POST https://open.volcengineapi.com?Action=DescribeWSStatistics&Version=2021-04-01
{
    "StartTime": "2024-08-09 16:00:00",
    "EndTime":  "2024-08-09 17:00:00",
    "Interval": 300,
    "Domains": [
        "xxx.test.com"
    ],
    "ProjectName": [
    ],
    "GroupByDomain": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024081417331751D9E5503AE0AC18D6E1",
        "Action": "DescribeWSStatistics",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domains": [
            "xxx.test.com"
        ],
        "Results": [
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:00:00",
                "WSCountValue": 4
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:05:00",
                "WSCountValue": 0
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:10:00",
                "WSCountValue": 4
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:15:00",
                "WSCountValue": 0
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:20:00",
                "WSCountValue": 0
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:25:00",
                "WSCountValue": 0
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:30:00",
                "WSCountValue": 0
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:35:00",
                "WSCountValue": 5
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:40:00",
                "WSCountValue": 5
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:45:00",
                "WSCountValue": 3
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:50:00",
                "WSCountValue": 3
            },
            {
                "DomainName": "xxx.test.com",
                "TimeStamp": "2024-08-09 16:55:00",
                "WSCountValue": 3
            }
        ]
    }
}