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

查询截图用量

最近更新时间2024.01.16 20:28:07

首次发布时间2023.10.16 10:38:46

此接口用于查询指定时间范围内截图功能的用量。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 权限说明:当使用子账号请求接口时,接口会按照子账号进行权限校验,只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

请求地址:https://vod.volcengineapi.com?Action=DescribeVodSnapshotData&Version=2023-07-01

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringDescribeVodSnapshotData接口名称。当前 API 的名称为 DescribeVodSnapshotData
VersionString2023-07-01接口版本。当前 API 的版本为 2023-07-01

SpaceList

String

test

点播空间名列表。多个空间名之间用英文逗号 , 隔开。

说明

如果是 POST 请求,此参数类型为 Array of String。

StartTimeString2021-04-13T00:00:00+08:00查询的起始时间。日期格式要求符合 RFC3339 规范。

EndTime

String

2021-04-14T00:00:00+08:00

查询的结束时间。日期格式要求符合 RFC3339 规范。

说明

查询时间跨度不超过 93 天。

SnapshotType

String

Sprite

截图类型。取值如下:

  • Poster:静态图
  • Sample:采样截图
  • Dynpost:动图
  • Animated:反复循环图
  • AIDynpost:智能封面(AI 动图)
  • Sprite:雪碧图

TaskStageList

String

busy

任务类型。多个任务类型之间用英文逗号 , 隔开。取值如下:

  • free:闲时任务
  • busy:正常任务

说明

如果是 POST 请求,此参数类型为 Array of String。

Aggregation

Long

3600

聚合的时间粒度。单位为秒。取值如下:

  • 86400:(默认)1 天
  • 3600:1 小时

DetailFieldList

String

Space

详细字段列表。取值如下:

  • Space:点播空间名
  • TaskStage:任务类型

说明

  • 如果参数不为空,会返回更详细的用量数据。
  • 如果是 POST 请求,此参数类型为 Array of String。

返回参数

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

参数类型示例值描述
SpaceListArray of String["test"]点播空间列表。
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

SnapshotType

String

Sprite

截图类型。取值如下:

  • Poster:静态图
  • Sample:采样截图
  • Dynpost:动图
  • Animated:反复循环图
  • AIDynpost:AI 动图
  • Sprite:雪碧图

TaskStageList

Array of String

["busy","free"]

任务类型列表。取值如下:

  • free:闲时任务
  • busy:正常任务

Aggregation

Long

3600

聚合的时间粒度。单位为秒。取值如下:

  • 3600:1 小时
  • 86400:1 天

DetailFieldList

Array of String

["TaskStage"]

详细字段列表。取值如下:

  • Space:点播空间名
  • TaskStage:任务类型
TotalSnapshotDataLong100所选时间段的截图总张数。
SnapshotDataListArray of SnapshotDataList-截图用量具体数据。
SnapshotDetailDataListArray of SnapshotDetailDataList-各种任务类型的截图用量。

SnapshotDataList

参数类型示例值描述
TimeString2022-04-13T00:00:00+08:00时间。
CountLong100截图张数。

SnapshotDetailDataList

参数类型示例值描述
SpaceStringtest点播空间名。

TaskStage

String

busy

任务类型。取值如下:

  • free:闲时任务
  • busy:正常任务
TotalString1000截图张数。
SnapshotDataListArray of SnapshotDataList-截图用量具体数据。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSnapshotData&Version=2023-07-01&Aggregation=3600&DetailFieldList=%5B%22TaskStage%22%5D&EndTime=2021-04-14T00%3A00%3A00%2B08%3A00&SnapshotType=%60Sprite%60&SpaceList=%5B%22test%22%5D&StartTime=2021-04-13T00%3A00%3A00%2B08%3A00&TaskStageList=%5B%22busy%22%2C%22free%22%5D

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata": {
    "RequestId": "201806041104***100232280022D30",
    "Action": "DescribeVodSnapshotData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceList": [
      "test"
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "TaskStageList": [
      "busy",
      "free"
    ],
    "DetailFieldList": [
      "TaskStage"
    ],
    "Aggregation": 3600,
    "TotalSnapshotData": 100,
    "SnapshotDataList": [
      {
        "Time": "2022-04-13T00:00:00+08:00",
        "Count": 100
      }
    ],
    "SnapshotDetailDataList": [
      {
        "TaskStage": "busy",
        "SnapshotDataList": [
          {
            "Time": "2022-04-13T00:00:00+08:00",
            "Count": 50
          }
        ]
      },
      {
        "TaskStage": "free",
        "SnapshotDataList": [
          {
            "Time": "2022-04-13T00:00:00+08:00",
            "Count": 50
          }
        ]
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: