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

请求说明

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

请求参数

返回参数

ResponseMetadata

ResponseError

VodDescribeVodSnapshotData

SnapShotDetailItem

SnapShotItem

示例

请求示例

如果用 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 各语言调用的示例代码，请参考如下：

• Java
• Python
• PHP
• Go