查询视频剪辑用量--视频点播-火山引擎

文档中心

立即注册

导航

查询视频剪辑用量

最近更新时间：2024.10.29 12:01:15首次发布时间：2023.04.21 18:43:59

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

请求说明

接口名称：DescribeVodSpaceEditStatisData
接口地址：http://vod.volcengineapi.com/?Action=DescribeVodSpaceEditStatisData&Version=2020-08-01
数据延迟：2 小时。

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `DescribeVodSpaceEditStatisData`。
Version	String	是	接口版本。当前接口取值为 `2020-08-01`。
SpaceList	Array of String	否	点播空间名列表。说明如果是 GET 请求，此参数类型为 String，多个空间名之间用 `,` 隔开。
StartTime	String	是	查询的起始时间。日期格式要求符合 RFC3339 规范。例如：`2022-04-18T20:00:00Z`。
EndTime	String	是	查询的结束时间。日期格式要求符合 RFC3339 规范。例如：`2022-04-18T22:00:00Z` 。说明单次查询的时间跨度不可超过 93 天。
Specification	String	否	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Aggregation	Integer	否	聚合的时间粒度。单位为秒。取值如下： `3600`：（默认）1 小时 `86400`：1 天
DetailFieldList	Array of String	否	详细字段列表。取值如下： `Space`：空间说明如果 `DetailFieldList` 不为空，会返回更详细的用量数据。

返回参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	响应通用信息
Result	VodDescribeVodSpaceEditStatisData	响应结果

ResponseMetadata

参数	类型	描述
RequestId	String	请求 ID
Action	String	请求接口
Version	String	版本
Service	String	服务
Region	String	区域
Error	ResponseError	异常信息

ResponseError

参数	类型	描述
Code	String	错误码
Message	String	详细错误信息

VodDescribeVodSpaceEditStatisData

参数	类型	描述
SpaceList	Array of String	点播空间名列表。
StartTime	String	查询的起始时间。日期格式要求符合 RFC3339 规范。例如：`2022-04-18T20:00:00Z`。
EndTime	String	查询的结束时间。日期格式要求符合 RFC3339 规范。例如：`2022-04-18T22:00:00Z` 。
Specification	String	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Aggregation	Integer	聚合的时间粒度。单位为秒。取值如下： `3600`：1 小时 `86400`：1 天
DetailFieldList	Array of String	详细字段列表。根据查询条件返回更详细的数据。取值如下： `Space`：点播空间名
TotalEditUsageData	Integer	所选时间段的视频剪辑总用量，单位为毫秒。
TotalEditUsageDataList	Array of EditUsageItem	各种分辨率的用量。
EditUsageDataDetailList	Array of EditUsageDetailData	视频剪辑用量具体数据。

EditUsageItem

参数类型描述

参数	类型	描述
Name	String	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Duration	Integer	时长，单位为毫秒

Name

String

输出视频规格。取值格式为 codec_definition。其中：

codec 取值可为 h.264、h.265、vp9。
definition 取值可为 360P、480P、540P、720P、1080P、2K、4K。

说明

高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。

Duration Integer 时长，单位为毫秒

EditUsageDetailData

参数	类型	描述
Space	String	点播空间名
Total	Integer	用量，单位为毫秒
EditUsageDataList	Array of EditUsageData	视频剪辑用量具体数据

EditUsageData

参数	类型	描述
Time	String	时间。符合 RFC3339 规范。例如：`2022-04-18T20:00:00Z`。
EditUsageItemList	Array 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
                       }
                    ]
                }
            ]
        }
    ]
  }
}

错误码

详见视频点播公共错误码。