调用 ListHighlightClipTasks 接口,分页查询高光智剪任务列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListHighlightClipTasks | 接口名称。当前 API 的名称为 ListHighlightClipTasks。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| SearchName | String | 是 | 任务名称 | 搜索关键词。支持按高光智剪任务名称或任务 ID 查询。 |
Status | Integer | 是 |
| 高光智剪任务状态。支持按任务状态查询。取值如下:
|
| PageNo | Long | 是 | 1 | 页码,从 1 开始。 |
| PageItemCount | Long | 是 | 10 | 每页返回的任务数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| HighlightClipJobList | Array of HighlightClipJobList | - | 符合查询条件的高光智剪任务列表。 |
| TotalCount | Integer | 10 | 符合查询条件的高光智剪任务总数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vid | String | v0c251g7007ada6nr77og65s9o4hv2rg | 高光智剪任务关联的原视频 Vid。 |
| CoverImage | String | https://p-boe-sign.bytedance.net/tos-boe-v-c1801c/o0Cqxxx | 高光智剪任务的封面图片 URL。包含协议头。 |
| CreateTime | Integer | 1787658478 | 高光智剪任务的创建时间,Unix 时间戳,单位为秒。 |
| Id | Long | 1 | 高光智剪任务 ID。 |
| Title | String | 剪辑任务名称 | 高光智剪任务的名称。 |
Status | Integer |
| 高光智剪任务状态。取值如下:
|
GET https://livesaas.volcengineapi.com/?Action=ListHighlightClipTasks&Version=2023-08-01&SearchName=任务名称&Status=0&PageNo=1&PageItemCount=10
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListHighlightClipTasks", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1" }, "Result": { "HighlightClipJobList": [ { "Vid": "v0c251g7007ada6nr77og65s9o4hv2rg", "CoverImage": "https://p-boe-sign.bytedance.net/tos-boe-v-c1801c/o0Cqxxx", "CreateTime": 1787658478, "Id": 1, "Title": "剪辑任务名称", "Status": 1 } ], "TotalCount": 10 } }