提交跨空间文件迁移任务--视频点播-火山引擎

文档中心

立即注册

导航

提交跨空间文件迁移任务

最近更新时间：2024.11.18 17:19:29首次发布时间：2024.03.26 14:44:51

此接口用于提交跨空间文件迁移任务，可将同账号下空间 A 的文件移动至空间 B。

注意事项

如您已为空间添加对象存储 Bucket，则无法使用此接口提交跨空间文件迁移任务。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`SubmitMoveObjectTask`	接口名称。当前 API 的名称为 `SubmitMoveObjectTask`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SourceSpace	String	是	`sourceSpace`	源空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
SourceFileName	String	是	`source.mp4`	源空间下待移动源文件的文件路径。规则如下：使用 UTF-8 编码。长度必须在 1～1024 个字符之间。不能以正斜线 `/`、反斜线 `\` 开头。不支持 `\a`、`\b`、`\t`、`\n`、`\v`、`\f`、`\r` 字符。不能包含 `//`、`./`、`/../` 等字符串。不能包含 `#`、`?`。
TargetSpace	String	是	`targetSpace`	目标空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
TargetFileName	String	否	`target.mp4`	目标空间下移动后的文件路径。如为空，目标空间下移动后的文件路径默认为 `SourceFileName`。规则如下：使用 UTF-8 编码。长度必须在 1～1024 个字符之间。不能以正斜线 `/`、反斜线 `\` 开头。不支持 `\a`、`\b`、`\t`、`\n`、`\v`、`\f`、`\r` 字符。不能包含 `//`、`./`、`/../` 等字符串。不能包含 `#`、`?`。
SaveSourceObject	Boolean	否	`false`	迁移结束后是否删除源文件。取值如下： `false`：（默认）删除源文件。 `true`：保留源文件。
ForceOverwrite	Boolean	否	`false`	是否开启强覆盖。如果目标文件已存在，支持强制覆盖文件。取值如下： `false`：（默认）不开启强制覆盖 `true`：开启强制覆盖。说明需要在空间下的上传存储设置页面开启覆盖上传，同时 `ForceOverwrite` 取值为 `true`，才能覆盖。

返回参数

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

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

SubmitMoveObjectTaskRespData

参数	类型	示例值	描述
TaskId	String	`8aec40ecfafc4ff29f0419503dfe78fa`	任务 ID。
SourceSpace	String	`sourceSpace`	源空间。
TargetSpace	String	`targetSpace`	目标空间。

请求示例

https://vod.volcengineapi.com?Action=SubmitMoveObjectTask&Version=2023-07-01&SourceSpace=sourceSpace&TargetSpace=targetSpace&SourceFileName=source.mp4&TargetFileName=&SaveSourceObject=false&ForceOverwrite=false

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202403171***8E48B5D879B29CB9D7E",
        "Action": "SubmitMoveObjectTask",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "TaskId": "8aec40ecfa***f0419503dfe78fa",
            "SourceSpace": "sourceSpace",
            "TargetSpace": "targetSpace"
        }
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter.FileSizeTooLarge	-	文件大小超过 5GB。
400	InvalidParameter.InvalidFileNameLength	-	文件名长度超过 1024 个字符。
400	InvalidParameter.InvalidSpace	-	空间不存在。
400	InvalidParameter.ForbidOverwrite	-	禁用覆盖，必须同时打开空间上传配置中允许覆盖开关。
400	InvalidParameter.ForbiddenCharacter	-	文件名中包含禁用字符。
404	ResourceNotFound.SourceFileNameNotExist	-	move 的源文件不存在。
404	ResourceNotFound.InvalidParams	-	入参错误，具体错误参数信息会在 message 中。
403	RequestForbidden.InvalidAccount	-	水平越权，必须是同账号下空间移动。
500	InternalError.*	-	服务端报错

服务端 SDK

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