You need to enable JavaScript to run this app.
导航
查询截图用量
最近更新时间:2023.07.12 17:56:38首次发布时间:2023.04.21 18:43:59

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

请求说明

  • 接口名称:DescribeVodSnapshotData
  • 接口地址:http://vod.volcengineapi.com/?Action=DescribeVodSnapshotData&Version=2020-08-01
  • 请求频率:单用户请求频率限制为 10 次/秒

请求参数

参数类型是否必选描述
ActionString接口名称。当前接口取值为 DescribeVodSnapshotData
VersionString接口版本。当前接口取值为 2020-08-01

SpaceList

Array of String

点播空间名列表。

说明

如果是 GET 请求,此参数类型为 String,多个空间名之间用 , 隔开。

SnapshotType

String

截图类型。取值如下:

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

TaskStageList

Array of String

任务类型。取值如下:

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

说明

如果是 GET 请求,此参数类型为 String,多个任务类型之间用 , 隔开。

StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

EndTime

String

查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

说明

单次查询的时间跨度不可超过 93 天。

Aggregation

Integer

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

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

DetailFieldList

Array of String

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

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

说明

如果参数不为空,会返回更详细的用量数据。

返回参数

参数类型描述
ResponseMetadataResponseMetadata响应通用信息
ResultVodDescribeVodSnapshotData响应结果

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

VodDescribeVodSnapshotData

参数类型描述
SpaceListArray of String点播空间列表。

SnapshotType

String

截图类型。取值如下:

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

TaskStageList

Array of String

任务类型。取值如下:

  • free:闲时任务
  • busy:正常任务
StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EndTimeString查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

DetailFieldList

Array

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

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

Aggregation

Integer

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

  • 3600:1 小时
  • 86400:1 天
TotalSnapshotDataInteger所选时间段的截图总张数。
SnapshotDataListArray of SnapShotItem截图用量具体数据。
SnapshotDetailDataListArray of SnapShotDetailItem各种任务类型的截图用量。

SnapShotDetailItem

参数类型描述
SpaceString点播空间名。

StageTask

String

任务类型。取值如下:

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

SnapShotItem

参数类型描述
TimeString时间。
CountInteger截图张数。

示例

请求示例

如果用 POST 方式发起请求,示例如下:

POST https://vod.volcengineapi.com?Action=DescribeVodSnapshotData&Version=2020-08-01 HTTP/1.1
Content-Type: application/json

{
  "Region": "cn-north-1",
  "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
}

如果用 GET 方式发起请求,示例如下:

GET https://vod.volcengineapi.com?Action=DescribeVodSnapshotData&Version=2020-08-01&DomainList=www.test.com&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3
&SpaceList=test&Aggregation=3600&TaskStageList=busy,free HTTP/1.1

正常返回示例

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

{
  "ResponseMetadata":{
    "RequestId": "201806041104***100232280022D30",
    "Action": "DescribeVodSnapshotData",
    "Version": "2020-08-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,
              }
          ]
      },
    ]
  }
}

异常返回示例

HTTP/1.1 400 Bad Request
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata":{
    "RequestId": "20180604110***00232280022D30",
    "Action": "DescribeVodSnapshotData",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1",
    "Error":{
      "Code": "280400",
      "Message": "must have X-Top-Account-Id"
    }
  }
}

错误码

详见视频点播公共错误码

服务端 SDK

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