Use the ListTasks API to list tasks. ## Debugging [去调试](https://api.volcengine.com/api-explorer/?action=ListTasks&groupName=openapi&serviceCode=dms&version=2025-01-01) ## Request parameters Only the request parameters specific to this API and some common parameters are listed below. For more information, see [Common Parameters](https://www.volcengine.com/docs/6369/67268). **Action ** string 必选 `Example: ListTasks` Action to perform: ListTasks. **Version ** string 必选 `Example value: 2025-01-01` API version: 2025\-01\-01. **PageSize ** integer 必选 `Example: 100` Page size. **IdCursor ** string 必选 `Example: 267` Pagination marker. **PageNumber ** integer 必选 `Example: 1` Page number. **FetchCount ** boolean `Optional` `Example: true` Retrieve the total count or not. ## Return parameters Only the unique return parameters for this API are listed below. For more information, see [Return structure](https://www.volcengine.com/docs/6369/80336). **HasNext ** boolean `Example: true` Is there a next page included. **TotalCount ** integer `Example: 100` Total number of tasks. **ItemList ** object[] `Example: -` Task information. **Id ** string `Example: 1*` Task ID. **AccountId ** string `Example value: 210000****` Account ID. **TaskName ** string `Sample value: task-name` Task name. **TaskType ** string `Example: HalfManaged` Task type with value descriptions: HalfManaged: Semi\-managed type. **TaskStatus ** string `Example value: Transferring` Task status, explained as follows: * Queueing: In the queue * Preparing: In preparation * Transferring: Transferring * Verifying: Verifying * Finished: Completed * Stopping: Stopping * Stopped: Stopped * Failing: Failing * Failed: Failed **SourceId ** string `Example: 1*` Source address ID. **DestinationId ** string `Example value: 1*` Target address ID. **AgentGroupId ** string `Example: 1*` Agent group ID. **TaskConfig ** object `Example: -` Task configuration. **StorageClassDirective ** string `Example: Standard` The storage class of the migrated object on the target side. See the following description for values: * Standard: Standard Storage. * InheritSource: Inherit source storage class. * Ia: Infrequent Access Storage. * ArchiveFr: Archive Flashback Storage. * IntelligentTiering: Intelligent Tiering Storage. * ColdArchive: Cold Archive Storage. * Archive: Archive Storage. * DeepColdArchive: Deep Cold Archive. **ListConfig ** object `Example: -` Task listing parameter configuration. **ListIncludePrefixes ** string[] `Sample value: [prefix1, prefix2]` List of prefixes to be migrated, separated by commas. **ListIncludeBeginTime ** string `Example: 1766974902040` Start time. The task will migrate objects whose modification time is later than this time, in milliseconds. **ListIncludeEndTime ** string `Example value: 1766974902040` End time. Tasks migrate objects whose modification time is earlier than this value. The value is a timestamp in milliseconds. **GenerateReport ** boolean `Example value: true` Generate a report. **ListIncludeBucketKeys ** object `Example value: -` Inventory configuration information. **Bucket ** string `Example value: test` Bucket name. **Ak ** string `Example: AKLTM2NlN2E5Yzg2ZDhkNDBjMGIzZGU3MDllMzE4NzU****` AccessKey ID for object storage access. **Sk ** string `Sample value: T1RkbVpHTmlNakl3TWpobE5EVmlObUkzTURrMU16STNZakF4TW****` AccessKey Secret for accessing object storage. **Keys ** string[] `Sample value: [objectname1, objectname2]` List of manifest file object names, separated by commas. **SymlinkPolicy ** string `Example value: follow` Migration policies for symbolic link files. The possible values are as follows: * skip: Do not migrate symbolic link files. * follow: Migrate symbolic link files to TOS as independent files. **OverwritePolicy ** string `Example: Force` Migration task overwrite policy. Description: * Force: For files with the same name, no check is performed. The destination is directly overwritten with the source. * None: For files with the same name, no check is performed and the file is directly skipped. * LastModify: When the source and destination have files with the same name, the system compares the lastmodify field (last modification time). The file is overwritten only if the source file’s last modification time is later than that of the destination. **CreateAt ** string `Example value: 1766974902040` Creation time, in milliseconds. **UpdateAt ** string `Example: 1766974902040` Update time in milliseconds timestamp. **TaskContext ** object `Example: -` Task execution details. **ErrorCode ** string `Example: 1003-00000001` Error code, which is the corresponding HTTP response code for error messages. **ErrorMessage ** string `Example value: do list objects on source failed` Error message, which provides a specific detailed description of the error in the response. ## Sample request ```text GET /?Action=ListTasks&Version=2025-01-01&PageSize=100&IdCursor=267&PageNumber=1 HTTP/1.1 Host: dms.cn-beijing.volcengineapi.com X-Date: 20251009T081527Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251009/cn-beijing/dms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f ``` ## Sample response ```text { "ResponseMetadata": { "RequestId": "20251009161535013040215171D1****", "Action": "ListTasks", "Version": "2025-01-01", "Service": "dms", "Region": "cn-beijing" }, "Result": { "HasNext": false, "TotalCount": 750, "ItemList": [ { "Id": "1*", "AccountId": "210000****", "TaskName": "task-name", "TaskType": "HalfManaged", "TaskStatus": "Transferring", "SourceId": "1*", "DestinationId": "1*", "CreateAt": "1766974902040", "UpdateAt": "1759997791000" } ] } } ``` ## Error codes The following table lists error codes related to this API and business logic. For general error codes, see the [General error codes](https://www.volcengine.com/docs/6369/68677) documentation. |Status Code |Error Code |Error message |Description | |---|---|---|---| |400 |2002\-00000012 |InvalidRequestBody |Parameter error. | |404 |2002\-00000014 |EntityNotFoundErr |The corresponding entity does not exist. | |500 |2001\-00000001 |ServiceInternalErr |Server error, try again later. |

Data Migration Service