ListDataMigrateTask--存储迁移服务-火山引擎

文档中心

导航

ListDataMigrateTask

最近更新时间：2024.10.09 17:39:38首次发布时间：2024.07.08 10:41:36

调用 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	Array of Object	-	迁移任务列表。

请求示例

POST /?Action=ListDataMigrateTask&Version=2018-01-01 HTTP/1.1
Host: open.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.	无效的参数。