You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播域名截图张数

最近更新时间：2023.10.12 17:39:57

首次发布时间：2021.11.22 11:40:05

我的收藏

支持查询用户直播截图计量数据。支持按照域名维度（含删除域名）查询，数据按天粒度聚合。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询直播域名截图张数接口。

注意事项

请求频率：单用户请求频率限制为 1 次/分钟。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribeSnapshotData&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeSnapshotData接口名称。当前 API 的名称为 DescribeSnapshotData。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
DomainListArray of String否["example.com","example2.com"]域名列表，缺省情况表示该用户的所有域名
StartTimeString是2022-03-07T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s；例如：2022-04-01T00:00:00+08:00
EndTimeString是2022-03-08T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s；例如：2022-04-02T00:00:00+08:00
AggregationInteger否86400数据聚合的时间粒度，单位为 s，支持按天粒度聚合，默认为 86400

返回参数

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

参数类型示例值描述
DomainListArray of String-域名列表
StartTimeString2022-03-07T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s
EndTimeString2022-03-08T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s
AggregationInteger86400时间粒度，单位为 s
CountInteger9503380所选域名的截图总张数
ListArray of SnapshotData-每个聚合时间片的截图张数详情

SnapshotData

参数类型示例值描述
TimeString2022-03-07T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s；例如，2022-04-13T00:00:00+08:00
CountInteger9503380截图总张数

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeSnapshotData&Version=2020-08-01
{
  "DomainList": [
    "example.com",
    "example2.com"
  ],
  "StartTime": "2022-03-07T00:00:00+08:00",
  "EndTime": "2022-03-08T00:00:00+08:00",
  "Aggregation": 86400
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeSnapshotData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "count": 0,
    "list": [
      {
        "Time": "2022-03-07T00:00:00+08:00",
        "Count": 9503380
      },
      {
        "Time": "2022-03-08T00:00:00+08:00",
        "Count": 9507820
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。