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

查询视频剪辑用量

最近更新时间2023.07.12 17:56:38

首次发布时间2023.04.21 18:43:59

此接口用户查询指定时间范围内视频剪辑功能的用量。

请求说明

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

请求参数

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

SpaceList

Array of String

点播空间名列表。

说明

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

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

EndTime

String

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

说明

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

Specification

String

封装格式。取值如下:

  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k

Aggregation

Integer

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

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

DetailFieldList

Array of String

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

  • Space:空间

说明

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

返回参数

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

ResponseMetadata

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

ResponseError

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

VodDescribeVodSpaceEditStatisData

参数类型描述
SpaceListArray of String点播空间名列表。
StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EndTimeString查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T22:00:00Z

Specification

String

封装格式。取值如下:

  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k

Aggregation

Integer

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

  • 3600:1 小时
  • 86400:1 天

DetailFieldList

Array of String

详细字段列表。根据查询条件返回更详细的数据。取值如下:

  • Space:点播空间名
TotalEditUsageDataInteger所选时间段的视频剪辑总用量,单位为毫秒。
TotalEditUsageDataListArray of EditUsageItem各种分辨率的用量。
EditUsageDataDetailListArray of EditUsageDetailData视频剪辑用量具体数据。

EditUsageItem

参数类型描述

Name

String

分辨率。取值如下:

  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k
DurationInteger时长,单位为毫秒

EditUsageDetailData

参数类型描述
SpaceString点播空间名
TotalInteger用量,单位为毫秒
EditUsageDataListArray of EditUsageData视频剪辑用量具体数据

EditUsageData

参数类型描述
TimeString时间。符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EditUsageItemListArray of EditUsageItem各种分辨率的用量。

示例

请求示例

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

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

{
  "SpaceList": ["test1", "test2"],
  "StartTime":   "2022-04-18T20:00:00Z",
  "EndTime":     "2022-04-18T22:00:00Z",
  "DetailFieldList": ["Space"]
}

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

GET http://vod.volcengineapi.com/?Action=DescribeVodSpaceEditStatisData&Version=2020-08-01&SpaceList=test1,test2&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3A00Z&DetailFieldList=Space HTTP/1.1

返回示例

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

{
  "ResponseMetadata":{
    "RequestId": "201806041104***100232280022D30",
    "Action": "DescribeVodSpaceEditStatisData",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result":{
    "SpaceList": ["test1", "test2"],
    "StartTime":   "2022-04-18T20:00:00Z",
    "EndTime":     "2022-04-18T22:00:00Z",
    "DetailFieldList": ["Space"],
    "Aggregation": 3600,
    "TotalEditUsageData": 100,
    "TotalEditUsageDataList": [
       {
         "Name": "H.264_4k",
         "Duration": 10
       }
    ],
    "EditUsageDataDetailList": [
        {
            "TaskStage": "test1",
            "Total": 40,
            "EditUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "EditUsageItemList": [
                       {
                          "Name": "H.264_4k",
                          "Duration": 10
                       },
                       {
                          "Name": "H.265_4k",
                          "Duration": 10
                       }
                    ]
                },
                {
                    "Time": "2022-04-18T21:00:00Z",
                    "EditUsageItemList": [
                       {
                          "Name": "H.264_4k",
                          "Duration": 10
                       },
                       {
                          "Name": "H.265_4k",
                          "Duration": 10
                       }
                    ]
                }
            ]
        },
        {
            "TaskStage": "test2",
            "Total": 10,
            "EditUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "EditUsageItemList": [
                       {
                          "Name": "H.264_4k",
                          "Duration": 10
                       }
                    ]
                }
            ]
        }
    ]
  }
}

错误码

详见视频点播公共错误码