文档中心

获取迁移任务详情

最近更新时间：2024.05.06 15:18:33

首次发布时间：2024.05.06 15:18:33

本接口支持分页获取当前账号下的迁移任务及其迁移详情。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageMigrateTasks`	接口名称。当前 API 的名称为 `GetImageMigrateTasks`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Region	String	否	`cn`	任务地区（即任务目标服务的地区），缺省时将返回国内列表。取值如下所示： `cn`：国内 `sg`：新加坡
TaskId	String	否	`648c15f764f3c4abd95ad044`	任务 ID。
ServiceId	String	否	`vu**yi`	迁移的目标服务 ID。
Offset	Long	否	`0`	分页偏移量，用于控制分页查询返回结果的起始位置，以便对数据进行分页展示和浏览。默认值为 0。说明例如，指定分页条数 Limit = 10，分页偏移量 Offset = 10，表示从查询结果的第 11 条记录开始返回数据，共展示 10 条数据。
Limit	Integer	否	`10`	分页查询时，显示的每页数据的最大条数。默认值为 10，最大值为 1000。
TaskNamePtn	String	否	`test`	返回任务名称中包含该值的迁移任务信息。
Status	String	否	`"Initial","Done"`	任务状态，填入多个时使用英文逗号分隔。取值如下所示： `Initial`：创建中 `Running`：运行中 `Done`：全部迁移完成 `Partial`：部分迁移完成 `Failed`：迁移失败 `Terminated`：中止

返回参数

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

参数	类型	示例值	描述
Tasks	Array of Tasks	`-`	迁移任务列表
Total	Long	`1`	总任务数

Tasks

参数	类型	示例值	描述
ID	String	`648c15f764f3c4abd95ad044`	任务 ID
Name	String	`test`	任务名称
Status	String	`Partial`	任务状态。取值如下所示： `Initial`：创建中 `Running`：运行中 `Done`：全部迁移完成 `Partial`：部分迁移完成 `Failed`：迁移失败 `Terminated`：中止
Source	Object of Source	`-`	源信息
Dst	Object of Dst	`-`	目标信息
Transcode	Object of Transcode	`-`	转码配置
RunStrategy	Object of RunStrategy	`-`	迁移策略
Progress	Object of Progress	`-`	迁移进度信息
Run	Array of Run	`-`	运行时长信息

Source

参数	类型	示例值	描述
Vendor	String	`S3`	源服务商
Region	String	`cn-beijing`	源 bucket 地区
Bucket	String	`migrate-test`	源 bucket
AK	String	`AKL****UwNWViYmJmYWI`	Access Key
SK	String	`Wm1J***1ZamMwWlRSbVpqZw==`	Secret Key
Endpoint	String	`http://tos-s3-cn-beijing.volces.com`	源 Endpoint
CdnHost	String	`my-bucket.oss-cn-hangzhou.aliyuncs.com`	迁移源云服务商 CDN 域名
SkipHeader	Boolean	`false`	是否丢弃源 Header，取值如下所示： `true`：丢弃源 Header `false`：不丢弃源 Header
Prefix	Array of String	`["base"]`	迁移前缀列表
Regex	Array of String	`["/.png/"]`	迁移正则表达式列表
TimeStart	String	`2023-06-10 00:00:00`	指定迁移开始时间点，为迁移开始当地服务器时间。表示仅迁移该时间段内新增或变更的文件。
TimeEnd	String	`2023-06-13 00:00:00`	指定迁移结束时间点，为迁移结束当地服务器时间。表示仅迁移该时间段内新增或变更的文件。

Dst

参数	类型	示例值	描述
ServiceId	String	`vu9***9yi`	服务 ID
ServiceName	String	`service-test`	服务名称
SkipBucket	Boolean	`false`	源 Bucket 名称保留规则
Prefix	String	`migrate-test/`	目标 key 前缀
UploadConf	Integer	`1`	上传配置。取值如下所示： `0`：直接覆盖同名文件 `1`：增加文件名后缀，后缀为任务 ID `2`：跳过同名文件，即不做迁移

Transcode

参数	类型	示例值	描述
Format	String	`png`	目标转码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。
Quality	Integer	`75`	转码质量参数。对于 PNG 为无损压缩，其他格式下其值越小，压缩率越高，画质越差。
AlphaDemotion	Boolean	`true`	包含透明通道的图片是否编码为降级格式。取值如下所示： `true`：降级 `false`：不降级
DemotionFmt	String	`heic`	降级编码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。

RunStrategy

参数类型示例值描述

参数	类型	示例值	描述
ReadQps	Array of Integer	`[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]`	源下载 QPS 限制。如值不为空，则长度必须为 24，表示一天 24 小时内各小时的 QPS 限制值。取值为负值时，表示无限制取值为 0 时，表示对应时间不允许迁移
ReadRate	Array of Integer	`[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]`	源下载流量限制。单位为 Byte。如值不为空，则长度必须为24，表示一天 24 小时内各小时的流量限制值。取值为负值时，表示无限制取值为 0 时，表示对应时间不允许迁移

ReadQps

Array of Integer

[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]

源下载 QPS 限制。如值不为空，则长度必须为 24，表示一天 24 小时内各小时的 QPS 限制值。

取值为负值时，表示无限制
取值为 0 时，表示对应时间不允许迁移

ReadRate

Array of Integer

[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]

源下载流量限制。单位为 Byte。如值不为空，则长度必须为24，表示一天 24 小时内各小时的流量限制值。

取值为负值时，表示无限制
取值为 0 时，表示对应时间不允许迁移

Progress

参数	类型	示例值	描述
SuccessCnt	Long	`4`	迁移成功文件数
FailCnt	Long	`1`	迁移失败文件数
TotalCnt	Long	`5`	总文件数
SuccessAmount	Long	`346641`	迁移成功文件量，单位为 byte
TotalAmount	Long	`5523453`	迁移文件总量，单位为 byte
ErrCode	Integer	`613100`	失败错误码。仅当 `Status`=`Failed` 时有值。
ErrMsg	String	`下载URL列表文件失败`	失败原因。仅当 `Status`=`Failed` 时有值。

Run

参数	类型	示例值	描述
StartAt	String	`2023-06-16 14:57:46`	迁移任务开始时间
DoneAt	String	`2023-06-16 14:57:49`	迁移任务结束时间

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageMigrateTasks&Version=2023-05-01&Region=cn&TaskId=648c15f764f3c4abd95ad044&ServiceId=vu**yi&Offset=0&Limit=10&TaskNamePtn=test&Status="Initial","Done"

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageMigrateTasks",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "ID": "662def9***d81c8295f",
                "Name": "migrate-test",
                "Status": "Done",
                "Source": {
                    "Vendor": "S3",
                    "AK": "AKLTYmIxMDIyYWUy**YwZWU3OTJmOTdkOGQ",
                    "SK": "WlRjeU4yVTVOR1Jq**rTURkbVkyVTNPVFEyT0RSbU9EQQ==",
                    "Region": "cn-beijing",
                    "Bucket": "migrate-test-1",
                    "Endpoint": "http://tos-s3-cn-beijing.demo.com",
                    "CdnHost": "migrate-test.tos-cn-beijing.demo.com",
                    "SkipHeader": false,
                    "Prefix": [
                        "base"
                    ],
                    "Regex": ["\.png"],
                    "TimeStart": "",
                    "TimeEnd": ""
                },
                "Transcode": {
                    "Format": "png",
                    "Quality": 75,
                    "AlphaDemotion": false,
                    "DemotionFmt": "heic"
                },
                "Dst": {
                    "ServiceId": "vu***yi",
                    "ServiceName": "service-test",
                    "SkipBucket": false,
                    "Prefix": "migrate-test/",
                    "UploadConf": 0
                },
                "Progress": {
                    "SuccessCnt": 4,
                    "FailCnt": 0,
                    "TotalCnt": 4,
                    "SuccessAmount": 7745499,
                    "TotalAmount": 7745499,
                    "ErrCode": 0,
                    "ErrMsg": ""
                },
                "Run": [
                    {
                        "StartAt": "2024-04-28 14:41:34",
                        "DoneAt": "2024-04-28 14:41:34"
                    }
                ],
                "RunStrategy": {
                    "ReadQps": null,
                    "ReadRate": null
                }
            }
        ],
        "Total": 1
    }
}

错误码

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

服务端 SDK

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