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

查询截图审核用量

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

首次发布时间：2022.08.17 18:24:27

我的收藏

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

说明

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

注意事项

  • 请求频率：单用户请求频率限制为 100 次/秒。
  • 数据延迟：1 天

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String否["live.example1.net","live.example2.net"]域名列表，缺省情况表示该用户的所有域名
StartTimeString是2022-08-03T00:00:00+08:00查询的起始时间。RFC3339 格式的 UTC 时间，精度为 s

EndTime

String

是

2022-08-04T00:00:00+08:00

查询的结束时间。RFC3339 格式的 UTC 时间，精度为 s
支持查询 366 天以内的数据

AggregationInteger否86400时间粒度，单位为 s，支持天粒度，默认为 86400

DetailField

Array of String

否

["Domain"]

用于指定数据拆分的维度。缺省情况下，表示只显示截图总张数，不做数据拆维展示。支持的取值为 Domain，表示按域名拆分数据。
例如，"DetailField":["Domain"]，则返回 DomainList 中每个域名的截图张数

返回参数

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

参数类型示例值描述
DomainListArray of String["live.example1.net","live.example2.net"]域名列表
StartTimeString2022-08-03T00:00:00+08:00查询的起始时间。RFC3339 格式的 UTC 时间，精度为 s
EndTimeString2022-08-04T00:00:00+08:00查询的结束时间。RFC3339 格式的 UTC 时间，精度为 s
AggregationInteger86400时间粒度，单位为 s
DetailFieldArray of String["Domain"]数据拆分的维度。取值为 Domain 时，表示按域名拆分数据
TotalCountInteger711所选域名的已经审核的截图总张数
AuditDataListArray of AuditData-审核截图数据
AuditDetailDataListArray of AuditDetailData-详细审核截图数据

AuditData

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

AuditDetailData

参数类型示例值描述
DomainStringlive.example2.net域名
TotalCountInteger0审核总张数
AuditDataListArray of AuditData-审核数据

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveAuditData&Version=2020-08-01
{
  "DomainList": [
    "live.example1.net",
    "live.example2.net"
  ],
  "StartTime": "2022-08-03T00:00:00+08:00",
  "EndTime": "2022-08-04T00:00:00+08:00",
  "Aggregation": 86400,
  "DetailField": [
    "Domain"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202208111530490101742442090201E99C",
    "Action": "DescribeLiveAuditData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "live.example1.net",
      "live.example2.net"
    ],
    "StartTime": "2022-08-03T00:00:00+08:00",
    "EndTime": "2022-08-04T00:00:00+08:00",
    "Aggregation": 86400,
    "DetailField": [
      "Domain"
    ],
    "TotalCount": 711,
    "AuditDataList": [
      {
        "TimeStamp": "2022-08-03T00:00:00+08:00",
        "Count": 711
      }
    ],
    "AuditDetailDataList": [
      {
        "Domain": "live.example1.net",
        "TotalCount": 711,
        "AuditDataList": [
          {
            "TimeStamp": "2022-08-03T00:00:00+08:00",
            "Count": 711
          }
        ]
      },
      {
        "Domain": "live.example2.net",
        "TotalCount": 0,
        "AuditDataList": [
          {
            "TimeStamp": "2022-08-03T00:00:00+08:00",
            "Count": 0
          }
        ]
      }
    ]
  }
}

错误码

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