取消或删除视频生成任务
字节API兼容
取消或删除视频生成任务
取消排队中的视频生成任务,或者删除视频生成任务记录。
DELETE
取消或删除视频生成任务
授权
在请求头中传入 Authorization: Bearer <token>。
路径参数
需要取消或者删除的视频生成任务 ID。
任务状态不同,调用 DELETE 接口执行的操作有所不同,具体说明如下:
| 当前任务状态 | 是否支持 DELETE 操作 | 操作含义 | DELETE 操作后任务状态 |
|---|---|---|---|
| queued | 是 | 任务取消排队,任务状态被变更为 cancelled。 | cancelled |
| running | 否 | - | - |
| succeeded | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
| failed | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
| cancelled | 否 | - | - |
| expired | 是 | 删除视频生成任务记录,后续将不支持查询。 | - |
说明:上面参数为Query String Parameters,在URL String中传入。
响应
200 - application/json
本接口无返回参数。