Call the ListDataMigrateTask API to list migration tasks. ## Request parameters Below are the unique request parameters for this API and some common parameters. For more information, see [Common Parameters](https://www.volcengine.com/docs/6369/67268). **Action ** string 必选 `Example value: ListDataMigrateTask` Operation to be performed: ListDataMigrateTask. **Version** string 必选`Example value: 2018-01-01` API version, value: 2018\-01\-01. **Offset ** integer 必选`Example value: 0` The starting position for each listing. The starting position for the most recently created task is 0. **Limit ** integer `Optional` `Example value: 10` The number of migration tasks returned by the request. **TaskStatus ** string `Optional` `Example value: Success` Specify the task statuses to list. The possible values are as follows: * `Preparing`: Task is being prepared. * `Transferring`: Task is in progress. * `Suspended`: Task has been suspended. * `Success`: Task completed successfully. * `Stopping`: Task is stopping. * `Stopped`: The task has been stopped. * `Failure`: The task has failed. * `ResultGenerating`: Generating task result. ## Response parameters Below are the unique response parameters for this API. For more information, refer to [Response Structure](https://www.volcengine.com/docs/6369/80336). **Count ** integer `Example value: 10` Number of tasks returned in this request. **Total ** integer `Example value: 10` Total number of tasks that meet the specified status **TaskList ** object[] `Example: -` Migration task list. **CreateTime ** string `Example value: 2024-05-14 19:20:39` Time when the task is created. **TaskID ** long `Example: 298686` Migration task ID. **TaskName ** string `Example value: dms` Name of the migration task. **TaskStatus ** string `Example: Success` Task status. Descriptions of possible values are as follows: * `Preparing`: The task is being prepared. * `Transferring`: The task is in progress. * `Suspended`: The task has been paused. * `Success`: The task completed successfully. * `Stopping`: The task is stopping. * `Stopped`: The task has been stopped. * `Failure`: The task failed. * `ResultGenerating`: Generate the task result. **TaskProgress ** object `Example value: -` Migration progress of the task. **FailedBytes ** long `Example value: 0` Number of bytes failed to migrate. **FailedObjects ** long `Example: 0` Number of failed migration objects. **RemainingBytes ** long `Example value: 0` Number of bytes not migrated. **RemainingObjects ** long `Example: 0` Number of objects not yet migrated. **NotExistBytes ** long `Example value: 0` Bytes that do not exist—bytes deleted from the source during migration. **NotExistObjectCount** long `Example value: 0` Number of missing objects, which indicates the number of objects deleted from the source during migration. **SkipBytes ** long `Example value: 0` Skipped bytes. DMS skips objects in archive, cold archive, and deep cold archive storage; when the overwrite policy is set to "no overwrite", DMS also skips files with the same name. Skipped bytes refer to the total number of bytes for all objects skipped during migration. **SkipObjectCount ** long `Example: 0` Number of skipped objects. DMS skips objects that are archived, cold archived, or deep cold archived; when the overwrite policy is set to not overwrite, DMS also skips files with the same name. The number of skipped objects is the total count of all objects skipped during the migration process. **TotalBytes ** long `Example value: 5357251` Total number of bytes. **TotalObjects ** long `Example value: 10003` Total number of objects. **TransferredBytes ** long `Example: 5357251` Number of bytes migrated successfully. **TransferredObjects ** long `Example value: 10003` Number of successfully migrated objects. **TransferBytesSpeed** long `Example value: 100` Average migration bandwidth. **TransferCountSpeed ** long `Example value: 100` Migration average QPS. ## Sample request ```text 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" } ``` ## Sample response ```json { "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 } } ``` ## Error codes The table below lists error codes related to this API and its business logic. For public error codes, see the [Public Error Codes](https://www.volcengine.com/docs/6369/68677) documentation. |Status Code |Error Code |Error message |Description | |---|---|---|---| |400 |InvalidParameter |Invalid Parameter. |Invalid parameter. |

Data Migration Service