文档

CancelVideoTask - 取消视频合成任务

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

通过提交任务生成的TaskUuid, 取消状态为”等待执行“的任务。

接口说明

警告 该接口只能取消状态为”等待执行“的任务,已运行或者已结束的任务不能取消。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:CancelVideoTaskWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TenantIdlong

租户 ID,从虚拟数字人开放平台中获取的 TenantId

xxxxx
Appobject

应用开发者信息,代表一个业务配置

AppIdstring

App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档

3d95xx946a
TaskUuidstring

任务 UUID,提交对应视频生成任务时返回的 TaskUuid。

xxxx-xxxx-xxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

xxxx-xxxx-xxxx
Codestring

返回错误码

502
Messagestring

错误消息

这是一个错误
Successboolean

是否成功

true
Dataobject

调用返回数据

TaskUuidstring

任务 UUID

xxxx-xxxx-xxxx
IsCancelboolean

是否取消

  • true:已取消
  • false: 未取消
true
FailReasonstring

取消失败原因

这里是取消失败原因

示例

正常返回示例

JSON格式

{
  "RequestId": "xxxx-xxxx-xxxx",
  "Code": "502",
  "Message": "这是一个错误",
  "Success": true,
  "Data": {
    "TaskUuid": "xxxx-xxxx-xxxx",
    "IsCancel": true,
    "FailReason": "这里是取消失败原因"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)