导出迁移失败列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

导出迁移失败列表

最近更新时间：2024.08.14 11:29:17首次发布时间：2024.05.06 15:18:33

本接口支持您通过指定部分迁移失败的任务 ID 来导出文件地址和迁移失败错误信息。

说明

您可通过调用 GetImageMigrateTasks获取 Status 为 Partial，即部分迁移失败的任务 ID。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=ExportFailedMigrateTask&Version=2023-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ExportFailedMigrateTask`	接口名称。当前 API 的名称为 `ExportFailedMigrateTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Region	String	是	`cn`	任务地区（即任务目标服务的地区），默认空，返回国内任务。 `cn`：国内 `sg`：新加坡
TaskId	String	是	`648c15f764f3c4abd95ad044`	任务 ID，请参考CreateImageMigrateTask获取返回的任务 ID。

返回参数

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

参数	类型	示例值	描述
Entries	Array of Entries	`-`	迁移失败文件列表。仅当任务状态为`Partial`时有值。

Entries

参数	类型	示例值	描述
Key	String	`http://test.com/mask4_3.png~tplv-yk**fd-222.png`	文件地址
ErrCode	Integer	`613102`	失败错误码
ErrMsg	String	`下载文件失败`	失败原因

请求示例

GET https://imagex.volcengineapi.com/?Action=ExportFailedMigrateTask&Version=2023-05-01&Region=cn&TaskId=648c15f764f3c4abd95ad044

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306301516296971A346ACCAC58AD93D",
        "Action": "ExportFailedMigrateTask",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Entries": [
            {
                "Key": "http://test.com/mask4_3.png~tplv-yk***fd-222.png",
                "ErrCode": 613102,
                "ErrMsg": "下载文件失败"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。

CodeN	错误信息
613110	源文件不存在
613111	三方云服务器或 URL 对应服务端异常
613112	无权限（例如签名过期）或归档资源未解冻
613102	除以上错误码失败原因外的其他情况导致的下载失败

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 ExportFailedMigrateTask 接口文档现已停止维护，建议您参考本文档使用最新版本。