查询视频剪辑详细数据--视频点播-火山引擎

文档中心

立即注册

导航

查询视频剪辑详细数据

最近更新时间：2023.07.12 17:56:38首次发布时间：2023.04.06 20:13:34

此接口用于查询指定时间范围内的视频剪辑详细数据。

请求说明

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

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `DescribeVodSpaceEditDetailData`。
Version	String	是	接口版本。当前接口取值为 `2022-12-01`。
Region	String	是	区域。当前仅支持 `cn-north-1`，表示华北。
Space	String	是	点播空间名称。您可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTime	String	是	查询的起始时间。最早可查询的时间是当前时间的 186 天之前。RFC3339 格式的 UTC 时间，精确到秒。例如，`2023-03-01T00:00:00+08:00`。
EndTime	String	是	查询的结束时间。RFC3339 格式的 UTC 时间，精确到秒。例如，`2023-03-02T00:00:00+08:00`。说明起始时间和结束时间的间隔不能超过 1 天，即一次可查询的时间范围是 1 天。
PageSize	Integer	否	分页查询的页大小。默认为 `100`，最大值为 `1000`。
PageNum	Integer	否	分页查询页号。从 `1` 开始，默认为 `1`。

返回参数

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

ResponseMetadata

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

ResponseError

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

DescribeVodSpaceEditDetailDataResult

参数	类型	描述
Region	String	区域。当前仅支持 `cn-north-1`，表示华北。
Space	String	点播空间名称。
StartTime	String	查询的起始时间。RFC3339 格式的 UTC 时间，精确到秒。例如，`2023-03-01T00:00:00+08:00`
EndTime	String	查询的结束时间。RFC3339 格式的 UTC 时间，精确到秒。例如，`2023-03-02T00:00:00+08:00`
PageSize	Integer	分页查询的页大小。
PageNum	Integer	分页查询页号。
Total	Integer	总数据条数。
EditDetailData	Array of EditDetailData	视频剪辑详细数据。

EditDetailData

参数	类型	描述
Time	String	任务执行的时间。RFC3339 格式的 UTC 时间，精确到秒。
Space	String	点播空间名称。
Codec	String	编码格式。取值如下： `h264`：H.264 `h265`：H.265 `vp9`：VP9 `Audio`：音频
Definition	String	分辨率。取值如下： `240P` `360P` `480P` `540P` `720P` `1080P` `2K` `4K` `8K`
OutputVid	String	输出视频剪辑任务的 `Vid`。
Duration	Integer	输出视频的时长，单位为毫秒。

示例

请求示例

如果用 POST 方式发起请求，示例如下：

POST https://vod.volcengineapi.com?Action=DescribeVodSpaceEditDetailData&Version=2022-12-01 HTTP/1.1
Content-Type: application/json

{
  "Region": "cn-north-1",
  "Space": "test",
  "StartTime": "2023-03-01T00:00:00+08:00",
  "EndTime": "2023-03-02T00:00:00+08:00",
  "PageSize": 100,
  "PageNum": 1
}

如果用 GET 方式发起请求，示例如下：

GET https://vod.volcengineapi.com?Action=DescribeVodSpaceEdotDetailData&Version=2022-12-01&Space=test&StartTime=2023-03-01T00%3A00%3A00%2B08%3A00&EndTime=2023-03-02T00%3A00%3A00%2B08%3A00&PageSize=100&PageNum=1 HTTP/1.1

正常返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "201806041104***0232280022D30",
        "Action": "DescribeVodSpaceEditDetailData",
        "Version": "2022-12-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Region": "cn-north-1",
        "Space": "test",
        "StartTime": "2023-03-01T00:00:00+08:00",
        "EndTime": "2023-03-02T00:00:00+08:00",
        "PageSize": 100,
        "PageNum": 1,
        "EditDetailData": [
            {
                "Time": "2023-03-01T00:00:00+08:00",
                "Codec": "H265",
                "Definiton": "1080P",
                "SpaceName": "test",
                "OutputVid": "eeeee",
                "Duration": 10
            },
            {
                "Time": "2023-03-02T00:00:00+08:00",
                "Codec": "H265",
                "Definiton": "1080P",
                "SpaceName": "test",
                "OutputVid": "eeeee",
                "Duration": 11
            }
        ]
    }
}

异常返回示例

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

{
  "ResponseMetadata":{
    "RequestId": "2018060411042***00232280022D30",
    "Action": "DescribeVodSpaceEditDetailData",
    "Version": "2022-12-01",
    "Service": "vod",
    "Region": "cn-north-1",
    "Error":{
      "Code": "InvalidParameter",
      "Message": "must have X-Top-Account-Id"
    }
  }
}

错误码

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

服务端 SDK

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