查询跨空间文件迁移任务状态--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

查询跨空间文件迁移任务状态

最近更新时间：2024.03.26 17:33:04首次发布时间：2024.03.26 14:44:51

此接口用于查询同账号下不同空间文件移动任务执行状态。

请求说明

请求地址：https://vod.volcengineapi.com?Action=QueryMoveObjectTaskInfo&Version=2023-07-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`QueryMoveObjectTaskInfo`	接口名称。当前 API 的名称为 `QueryMoveObjectTaskInfo`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
TaskId	String	是	`db3ab211095******b0955a30b550`	任务 ID。可通过 SubmitMoveObjectTask 获取。
SourceSpace	String	是	`testA`	源空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
TargetSpace	String	是	`testB`	目标空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。

返回参数

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

参数	类型	示例值	描述
Data	Object of Data	`-`	数据。

Data

参数	类型	示例值	描述
TaskId	String	`db3ab211095******b0955a30b550`	任务 ID。
SourceSpace	String	`testA`	源空间名称。
TargetSpace	String	`testB`	目标空间名称。
State	String	`success`	任务执行状态。取值如下： `initial` `processing` `success` `failed`
TaskRunResult	String	`move success`	任务执行结果。

请求示例

https://vod.volcengineapi.com?Action=QueryMoveObjectTaskInfo&Version=2023-07-01&SourceSpace=sourceSpace&TargetSpace=targetSpace&TaskId=b229a37010544cf6976***4dd3a35b31

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031716***6D42632C675C1D416",
        "Action": "QueryMoveObjectTaskInfo",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "taskId": "b229a3701054***9f74dd3a35b3",
            "SourceSpace": "sourceSpace",
            "TargetSpace": "targetSpace",
            "State": "success",
            "TaskRunResult": "move success"
        }
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.InvalidSpace	-	空间不存在
403	RequestForbidden.InvalidSpace	-	Task 对应的 SourceSpace & TargetSpace 必须保持一致
404	ResourceNotFound.InvalidParams	-	入参错误，如 taskId 不存在
500	InternalError.*	-	服务端报错

SDK

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