You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /
  • veImageX

获取迁移任务详情

最近更新时间：2024.02.19 15:03:03

首次发布时间：2023.07.05 14:39:54

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetImageMigrateTasks接口名称。当前 API 的名称为 GetImageMigrateTasks。
VersionString是2018-08-01接口版本。当前 API 的版本为 2018-08-01。

Region

String

否

cn

任务地区（即任务目标服务的地区），缺省时将返回国内列表。取值如下所示：

  • cn：国内
  • sg：新加坡
TaskIdString否648c15f764f3c4abd95ad044任务 ID。
ServiceIdString否vu**yi迁移的目标服务 ID。
OffsetInteger否0分页偏移量。默认值为 0，表示从最新一个开始获取。
LimitInteger否10分页条数。默认值为 10，最大值为 1000。
TaskNamePtnString否test返回任务名称中包含该值的迁移任务信息。

Status

String

否

"Initial","Done"

任务状态，填入多个时使用半角逗号分隔。取值如下所示：

  • Initial：创建中
  • Running：运行中
  • Done：全部迁移完成
  • Partial：部分迁移完成
  • Failed：迁移失败
  • Terminated：中止

返回参数

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

参数类型示例值描述
TasksArray of Tasks-迁移任务列表
TotalInteger1总任务数

Tasks

参数类型示例值描述
IDString648c15f764f3c4abd95ad044任务 ID
NameStringtest任务名称

Status

String

Partial

任务状态。取值如下所示：

  • Initial：创建中
  • Running：运行中
  • Done：全部迁移完成
  • Partial：部分迁移完成
  • Failed：迁移失败
  • Terminated：中止
SourceObject of Source-源信息
DstObject of Dst-目标信息
TranscodeObject of Transcode-转码配置
RunStrategyObject of RunStrategy-迁移策略
ProgressObject of Progress-迁移进度信息
RunArray of Run-运行时长信息

Source

参数类型示例值描述
VendorStringS3源服务商
RegionStringcn-beijing源 bucket 地区
BucketStringmigrate-test源 bucket
AKStringAKL****UwNWViYmJmYWIak
SKStringWm1J***1ZamMwWlRSbVpqZw==sk
EndpointStringhttp://tos-s3-cn-beijing.volces.com源 Endpoint
CdnHostStringmy-bucket.oss-cn-hangzhou.aliyuncs.com迁移源云服务商 CDN 域名

SkipHeader

Boolean

false

是否丢弃源 Header，取值如下所示：

  • true：丢弃源 Header
  • false：不丢弃源 Header
PrefixArray of Stringbase迁移前缀列表
RegexArray of String/.png/迁移正则表达式列表
TimeStartString2023-06-10 00:00:00指定迁移开始时间点，为迁移开始当地服务器时间。表示仅迁移该时间段内新增或变更的文件。
TimeEndString2023-06-13 00:00:00指定迁移结束时间点，为迁移结束当地服务器时间。表示仅迁移该时间段内新增或变更的文件。

Transcode

参数类型示例值描述
FormatStringpng目标转码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。
QualityInteger75转码质量参数。对于 PNG 为无损压缩，其他格式下其值越小，压缩率越高，画质越差。

AlphaDemotion

Boolean

true

包含透明通道的图片是否编码为降级格式。取值如下所示：

  • true：降级
  • false：不降级
DemotionFmtStringheic降级编码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。

Dst

参数类型示例值描述
ServiceIdStringvu9***9yi服务 ID
ServiceNameStringservice-test服务名称

SkipBucket

Boolean

false

源 Bucket 名称保留规则，取值如下所示：

  • true：不保留，迁移后资源访问 URI 中，不保留迁移源的 Bucket 名称。
  • false：保留，迁移后资源访问 URI 中，会保留迁移源的 Bucket 名称。
PrefixStringmigrate-test/目标 key 前缀

UploadConf

Integer

1

上传配置。取值如下所示：

  • 0：直接覆盖同名文件
  • 1：增加文件名后缀，后缀为 任务 ID
  • 2：跳过同名文件，即不做迁移

Progress

参数类型示例值描述
SuccessCntInteger4迁移成功文件数
FailCntInteger1迁移失败文件数
TotalCntInteger5总文件数
SuccessAmountInteger346641迁移成功文件量，单位为 byte
TotalAmountInteger5523453迁移文件总量，单位为 byte
ErrCodeInteger613100失败错误码。仅当 Status=Failed 时有值
ErrMsgString下载URL列表文件失败失败原因。仅当 Status=Failed 时有值

RunStrategy

参数类型示例值描述

ReadQps

Integer Array

{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

Integer Array

{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 时，表示对应时间不允许迁移

Run

参数类型示例值描述
StartAtString2023-06-16 14:57:46迁移任务开始时间
DoneAtString2023-06-16 14:57:49迁移任务结束时间

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageMigrateTasks&Version=2018-08-01&TaskId=648c0**1cab5d0&Region=cn

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230616174559F20226928FE7760C9066",
        "Action": "GetImageMigrateTasks",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Tasks": [
            {
                "ID": "648c07ea22882fcf01cab5d0",
                "Name": "migrate-test",
                "Status": "Partial",
                "Source": {
                    "Vendor": "S3",
                    "AK": "AKL****UwNWViYmJmYWI",
                    "SK": "Wm1J***1ZamMwWlRSbVpqZw==",
                    "Region": "cn-beijing",
                    "Bucket": "migrate-test",
                    "Endpoint": "http://tos-s3-cn-beijing.volces.com",
                    "CdnHost": "migrate-test.tos-cn-beijing.volces.com",
                    "SkipHeader": false,
                    "Prefix": [
                        "base",
                        "alpha_image"
                    ],
                    "Regex": [],
                    "TimeStart": "",
                    "TimeEnd": ""
                },
                "Transcode": {
                    "Format": "heic",
                    "Quality": 100,
                    "AlphaDemotion": false,
                    "DemotionFmt": ""
                },
                "Dst": {
                    "ServiceId": "vu**yi",
                    "ServiceName": "service-test",
                    "SkipBucket": false,
                    "Prefix": "migrate-test/",
                    "UploadConf": 0
                },
                "Progress": {
                    "SuccessCnt": 5,
                    "FailCnt": 1,
                    "TotalCnt": 6,
                    "SuccessAmount": 7665638,
                    "TotalAmount": 7665638,
                    "ErrCode": 0,
                    "ErrMsg": ""
                },
                "Run": [
                    {
                        "StartAt": "2023-06-16 14:57:46",
                        "DoneAt": "2023-06-16 14:57:49"
                    }
                ],
                "RunStrategy": {
                    "ReadQps": null,
                    "ReadRate": null
                }
            }
        ]
    }
}

错误码

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

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，当前已提供了Java SDK供您调试使用。