You need to enable JavaScript to run this app.
文档中心
存储迁移服务

存储迁移服务

复制全文
下载 pdf
DMS OpenAPI
ListDataMigrateTask - 列举迁移任务
复制全文
下载 pdf
ListDataMigrateTask - 列举迁移任务
调用 ListDataMigrateTask 接口列举迁移任务。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListDataMigrateTask​
要执行的操作,取值:ListDataMigrateTask。​
​
Version string 必选 示例值:2018-01-01​
API的版本,取值:2018-01-01。​
​
Offset integer 必选 示例值:0​
每次列举的起始位置,最近创建的任务起始位置为 0。​
​
Limit integer 可选 示例值:10​
请求返回的迁移任务数量。​
​
TaskStatus string 可选 示例值:Success​
需要列举的任务状态,取值说明如下:​
  • Preparing:任务准备中。​
  • Transferring:任务正在执行中。​
  • Suspended:任务已暂停。​
  • Success:任务已成功。​
  • Stopping:任务停止中。​
  • Stopped:任务已停止。​
  • Failure:任务已失败。​
  • ResultGenerating:生成任务结果。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Count integer 示例值:10​
本次请求返回的任务数量。​
​
Total integer 示例值:10​
符合指定状态的任务总数。​
​
TaskList object[] 示例值:-​
迁移任务列表。​
CreateTime string 示例值:2024-05-14 19:20:39​
任务创建时间。​
​
TaskID long 示例值:298686​
迁移任务 ID。​
​
TaskName string 示例值:dms​
迁移任务的名称。​
​
TaskStatus string 示例值:Success​
任务状态,取值说明如下:​
  • Preparing:任务准备中。​
  • Transferring:任务正在执行中。​
  • Suspended:任务已暂停。​
  • Success:任务已成功。​
  • Stopping:任务停止中。​
  • Stopped:任务已停止。​
  • Failure:任务已失败。​
  • ResultGenerating:生成任务结果。​
​
TaskProgress object 示例值:-​
任务迁移进度。​
FailedBytes long 示例值:0​
迁移失败字节数。​
​
FailedObjects long 示例值:0​
迁移失败对象数量。​
​
RemainingBytes long 示例值:0​
未迁移字节数。​
​
RemainingObjects long 示例值:0​
未迁移对象数量。​
​
NotExistBytes long 示例值:0​
不存在字节数,即迁移过程中,源端删除的字节数。​
​
NotExistObjectCount long 示例值:0​
不存在对象数,即迁移过程中,源端删除的对象数量。​
​
SkipBytes long 示例值:0​
跳过字节数。DMS 会跳过归档、冷归档和深度冷归档的对象;设置覆盖策略为不覆盖时,DMS 也会跳过同名文件;跳过字节数即迁移过程中,跳过的所有对象的字节数。​
​
SkipObjectCount long 示例值:0​
跳过对象数。DMS 会跳过归档、冷归档和深度冷归档的对象;设置覆盖策略为不覆盖时,DMS 也会跳过同名文件;跳过对象数即迁移过程中,跳过的所有对象的数量。​
​
TotalBytes long 示例值: 5357251​
总字节数。​
​
TotalObjects long 示例值:10003​
总对象数量。​
​
TransferredBytes long 示例值: 5357251​
迁移成功字节数。​
​
TransferredObjects long 示例值:10003​
迁移成功对象数量。​
​
TransferBytesSpeed long 示例值:100​
迁移平均带宽。​
​
TransferCountSpeed long 示例值:100​
迁移平均 QPS。​
​
​
​
​
​
请求示例​
​
POST /?Action=ListDataMigrateTask&Version=2018-01-01 HTTP/1.1​
Host: dms.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20240511T081028Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240511/cn-beijing/dms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"Offset": 0,​
"TaskStatus": "Success"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240511161041155141166252D1****",​
"Action": "ListDataMigrateTask",​
"Version": "2018-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"Count": 1,​
"TaskList": [​
{​
"CreateTime": "2024-05-14 19:20:39",​
"TaskID": 84,​
"TaskName": "test",​
"TaskProgress": {​
"FailedBytes": 0,​
"FailedObjects": 0,​
"NotExistBytes": 0,​
"NotExistObjectCount": 0,​
"RemainingBytes": 0,​
"RemainingObjects": 0,​
"SkipBytes": 5357251,​
"SkipObjectCount": 10003,​
"TotalBytes": 5357251,​
"TotalObjects": 10003,​
"TransferBytesSpeed": 0,​
"TransferCountSpeed": 0,​
"TransferredBytes": 0,​
"TransferredObjects": 0​
},​
"TaskStatus": "Success"​
}​
],​
"Total": 40​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
Invalid Parameter.​
无效的参数。​
​
​
最近更新时间:2026.01.27 18:52:32
这个页面对您有帮助吗?
有用
有用
无用
无用