文档中心

导出迁移失败列表

最近更新时间：2023.11.14 16:10:34

首次发布时间：2023.07.03 19:37:52

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

注意事项

请求频率：单用户请求频率限制为 100 次/秒。
超时时间：超时时间约 10 秒。

请求说明

请求方式：GET
请求地址示例：https://imagex.volcengineapi.com/?Action=ExportFailedMigrateTask&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ExportFailedMigrateTask`	接口名称。`ExportFailedMigrateTask`
Version	String	是	`2018-08-01`	接口版本。
Region	String	否	`cn`	任务地区（即任务目标服务的地区），默认空，返回国内任务。 `cn`：国内 `va`：美东 `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=2018-08-01&TaskId=649e80***c4544cb1&Region=cn

返回示例

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

错误码

访问公共错误码以及通用错误码获取详细信息。

服务端 SDK

推荐您使用服务端 SDK 来调用 API，我们已在 GitHub 提供了 Java 的参考示例。