通过提交任务生成的TaskUuid, 取消状态为”等待执行“的任务。
接口说明
警告 该接口只能取消状态为”等待执行“的任务,已运行或者已结束的任务不能取消。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:CancelVideoTask | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户 ID,从虚拟数字人开放平台中获取的 TenantId | xxxxx |
App | object | 是 | 应用开发者信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档。 | 3d95xx946a |
TaskUuid | string | 是 | 任务 UUID,提交对应视频生成任务时返回的 TaskUuid。 | xxxx-xxxx-xxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "xxxx-xxxx-xxxx",
"Code": "502",
"Message": "这是一个错误",
"Success": true,
"Data": {
"TaskUuid": "xxxx-xxxx-xxxx",
"IsCancel": true,
"FailReason": "这里是取消失败原因"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-08-18 | API 内部配置变更,不影响调用 | 看变更集 | ||
|