取消剪辑任务--视频点播-火山引擎

文档中心

立即注册

导航

取消剪辑任务

最近更新时间：2024.06.18 16:17:08首次发布时间：2024.04.10 19:05:50

此接口用于通过 ReqId 参数取消视频剪辑任务。

请求说明

请求方式：POST
请求地址：https://vod.volcengineapi.com?Action=CancelDirectEditTask&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CancelDirectEditTask`	接口名称。当前 API 的名称为 `CancelDirectEditTask`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
ReqId	String	是	`e070c***********5657debe7d6547`	任务 ID。您可通过调用 SubmitDirectEditTaskAsync 接口的返回参数获取。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Message	String	`success`	取消视频剪辑任务成功信息。

请求示例 1

取消视频剪辑任务成功的请求示例如下：

POST https://vod.volcengineapi.com?Action=CancelDirectEditTask&Version=2018-01-01
{
    "ReqId": "e070c*************ebe7d6547"
}

返回示例 1

取消视频剪辑任务成功的返回示例如下：

{
    "ResponseMetadata": {
        "RequestId": "20240409194439***99328D4A6E1A0E",
        "Action": "CancelDirectEditTask",
        "Version": "2018-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success"
    }
}

请求示例 2

取消视频剪辑任务失败的请求示例如下：

POST https://vod.volcengineapi.com?Action=CancelDirectEditTask&Version=2018-01-01

返回示例 2

取消视频剪辑任务失败的返回示例如下：

{
    "ResponseMetadata": {
        "RequestId": "202404******************CC6CE95E",
        "Action": "CancelDirectEditTask",
        "Version": "2018-01-01",
        "Service": "vod",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.InvalidParam",
            "CodeN": 1010,
            "Message": "status error: task has been canceled"
        }
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：