调用 ListHighLightTask
接口,查询和管理高光智能剪辑任务的基本信息和状态。您可以通过任务 ID、状态、创建时间、停止时间等条件筛选任务,并获取任务的名称、状态、创建时间、停止时间等详细信息。该接口支持分页查询,适用于任务监控、状态跟踪和故障排查等场景。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListHighLightTask | 接口名称。当前 API 的名称为 ListHighLightTask 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
TaskIds | Array of String | 否 | ["14jks8fn****54bskhe"] | 若干高光剪辑任务的唯一标识符列表,用于指定需要查询的具体任务。 |
TaskStatus | Array of String | 否 |
| 高光剪辑任务的状态列表,用于筛选指定状态的任务,默认查询所有状态的任务。支持的状态包括:
|
CreateTimeSt | String | 否 | 2023-01-01T00:00:00+08:00 | 遍历在某个时间范围内创建的高光剪辑任务,时间范围的起始时间,RFC3339 格式的时间戳,精度为秒。 |
CreateTimeEd | String | 否 | 2023-01-31T23:59:59+08:00 | 遍历在某个时间范围内创建的高光剪辑任务,时间范围的截止时间,RFC3339 格式的时间戳,精度为秒。 |
StopTimeSt | String | 否 | 2023-01-01T00:00:00+08:00 | 遍历在某个时间范围内停止的高光剪辑任务,时间范围的起始时间,RFC3339 格式的时间戳,精度为秒。 |
StopTimeEd | String | 否 | 2023-01-31T23:59:59+08:00 | 遍历在某个时间范围内停止的高光剪辑任务,时间范围的截止时间,RFC3339 格式的时间戳,精度为秒。 |
Page | Integer | 是 | 0 | 遍历任务的分页数,用于指定查询结果的页码。 |
PageSize | Integer | 是 | 10 | 遍历任务单页的任务数量,用于指定每页返回的任务记录数。 |
Order | String | 否 |
| 遍历结果任务的排序方式,默认值为
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Object of Data | - | 返回的高光剪辑任务数据,包含任务总数和任务详情列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Count | Integer | 20 | 遍历任务总数,表示当前账号下高光剪辑任务的总数量。 |
Result | Array of Result | - | 高光剪辑任务的详情列表,包含每个任务的基本信息和状态。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountID | String | 1000****1231 | 高光剪辑任务所属的账号 ID,用于标识任务所属的账号。 |
Name | String | test | 高光剪辑任务的名称,用于标识和区分不同的任务。 |
Status | String |
| 高光剪辑任务的状态,可能的取值如下所示。
|
TaskID | String | 5252cd****62e3ff | 高光剪辑任务的唯一标识符,由系统在任务创建时返回。 |
POST https://live.volcengineapi.com?Action=ListHighLightTask&Version=2023-01-01 { "TaskIds": [ "14jks8fn****54bskhe" ], "TaskStatus": [ "running" ], "CreateTimeSt": "2023-01-01T00:00:00+08:00", "CreateTimeEd": "2023-01-31T23:59:59+08:00", "StopTimeSt": "2023-01-01T00:00:00+08:00", "StopTimeEd": "2023-01-31T23:59:59+08:00", "Page": 0, "PageSize": 10, "Order": "desc" }
{ "ResponseMetadata": { "RequestID": "12345678-1234-5678-1234-567812345678", "Action": "ListHighLightTask", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": { "Count": 20, "Result": [ { "AccountID": "1000****1231", "Name": "test", "Status": "running", "TaskID": "5252cd****62e3ff" }, { "AccountID": "1000****1232", "Name": "test2", "Status": "done", "TaskID": "5252cd****62e3fg" } ] } } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |