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

查询视频剪辑用量

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

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

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

注意事项

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

请求说明

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

调试

请求参数

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

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

SpaceList

String

test

点播空间名列表。多个空间名之间用 , 隔开。

说明

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

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

EndTime

String

2022-04-18T22:00:00Z

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

说明

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

Specification

String

H.264_240p

封装格式。取值如下:

  • 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

Long

3600

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

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

DetailFieldList

String

Space

详细字段列表。取值为 Space:空间。

说明

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

返回参数

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

参数类型示例值描述
SpaceListArray of String["test1","test2"]点播空间名列表。
StartTimeString2022-04-18T20:00:00Z查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EndTimeString2022-04-18T22:00:00Z查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T22:00:00Z 。 查询时间不超过 93 天。

Specification

String

H.264_240p

封装格式。取值如下:

  • 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

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

  • 3600:1 小时
  • 86400:1 天
DetailFieldListArray of String["Space"]详细字段列表。根据查询条件返回更详细的数据。取值为 Space:空间。
TotalEditUsageDataInteger100所选时间段的视频剪辑总用量,单位为毫秒。
TotalEditUsageDataListArray of TotalEditUsageDataList-各种分辨率的用量。
EditUsageDataDetailListArray of EditUsageDataDetailList-视频剪辑用量具体数据。

TotalEditUsageDataList

参数类型示例值描述

Name

String

H.264_4k

名称。取值如下:

  • 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
DurationInteger10时长,单位为毫秒。

EditUsageDataDetailList

参数类型示例值描述
SpaceStringtest点播空间名称。
TotalInteger10用量,单位为毫秒。
EditUsageDataListArray of EditUsageDataList-视频剪辑用量的具体数据。

EditUsageDataList

参数类型示例值描述
TimeString2022-04-18T20:00:00Z时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EditUsageItemListArray of EditUsageItemList-各种分辨率的用量。

EditUsageItemList

参数类型示例值描述

Name

String

H.264_4k

分辨率。取值如下:

  • 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
DurationInteger10时长,单位为毫秒。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceEditStatisData&Version=2023-07-01&SpaceList=["test1","test2"]&StartTime=2022-04-18T20:00:00Z&EndTime=2022-04-18T22:00:00Z&Specification=&Aggregation=&DetailFieldList=["Space"]

返回示例

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

{
  "ResponseMetadata":{
    "RequestId": "201806041104***100232280022D30",
    "Action": "DescribeVodSpaceEditStatisData",
    "Version": "2023-07-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
                       }
                    ]
                }
            ]
        }
    ]
  }
}

错误码

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