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

文档中心

立即注册

导航

查询视频剪辑详细数据

最近更新时间：2024.01.16 20:28:07首次发布时间：2023.10.16 10:38:47

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

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

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

返回参数

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

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

EditDetailData

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

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceEditDetailData&Version=2023-07-01&EndTime=2023-03-02T00%3A00%3A00%2B08%3A00&PageNum=1&PageSize=100&Region=cn-north-1&Space=test&StartTime=2023-03-01T00%3A00%3A00%2B08%3A00

返回示例

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

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

错误码

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

服务端 SDK

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