API v1

取消视频任务

POST/v1/video/tasks/{task_id}/cancel

需要 service.use 权限,必须提供 Idempotency-Key,请求体必须为空。

查看 Markdown
  • 在请求头 Authorization: Bearer 后面放 API 密钥;请求体为空。
  • 必须带 Idempotency-Key;同一个键重放原响应。
  • 生成开始前取消立即生效,任务变为 cancelled,预留全额释放。
  • 生成开始后返回 not_effective,任务继续生成并照常结算。

请求头

#Authorizationstring必填

Bearer 加一个空格和 API 密钥。缺失或无效时返回 401 authentication_failed。

#X-Request-IDstring

你自己的请求标识。无效或重复的值会被替换,最终值在响应头 X-Request-ID 返回。

#Idempotency-Keystring必填

每个新请求生成一个新值并保存,以字母或数字开头。结果不明时用同一个键和原请求体重试,会返回原响应;同一个键配不同的请求体返回 409 idempotency_conflict。键按团队区分,不按 API 密钥区分。

长度8–128字符A–Z a–z 0–9 . _ : -

路径参数

#task_idstring必填

平台视频任务标识

返回HTTP 202

不可变的取消操作快照;effective 表示已取消,not_effective 表示本次取消未生效,须继续查询任务与账单。

#task_idstring必填

本团队的视频任务标识。

长度4–128字符A–Z a–z 0–9 _ -
#cancel_operation_idstring必填

取消操作的稳定标识,同一任务的新操作键引用同一个标识。

长度4–128字符A–Z a–z 0–9 _ -
#cancel_statusstring必填

取消操作状态;首发直接回答已生效或未生效。

requested已请求取消
effective取消已生效
not_effective取消未生效
failed失败
#task_status_at_responsestring必填

该操作键首次应答时冻结的任务状态,重放时不会更新。

queued排队中
processing处理中
succeeded已成功
failed已失败
cancelled已取消
#reason_codestring必填可能为空

已生效时为空;生成已开始而未生效时为 generation_already_started。

长度1–96字符a–z 0–9 _

响应头

#X-Request-IDstring必填

本次请求的标识:你提供的有效值,或替换后的值。

#Locationstring必填

已接受对象的规范查询路径。

状态码

每个 error.code 的处理办法见「错误码」。

状态码说明与 error.code
202不可变的取消操作快照;effective 表示已取消,not_effective 表示本次取消未生效,须继续查询任务与账单。
响应头Location
400请求无效。
401API 密钥缺失或无效。
响应头WWW-Authenticate
404任务不存在或对本团队不可见。
409已有操作键对应不同请求,或终态任务没有可引用的取消操作。
429请求频率限制拒绝此非创建操作。
响应头Retry-After
500服务内部错误。
503服务暂时不可用。