# Get Task List Information - ListUDTSTask

## Overview

Obtain the Task information created by the user






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUDTSTask`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **Offset** | string | Offset, default is 0 |No|
| **Limit** | string | Number of requests, default is 20 |No|
| **Type** | string | Task Type |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Data** | array[[*ListDataItem*](#listdataitem)] | ListDataItem Array |**Yes**|

#### Data Model


#### ListDataItem

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ServiceType** | string | Service Type, small, medium, large |**Yes**|
| **ChargeType** | string | Resource payment type, enumeration: Dynamic/ Month/ Year/ Trial/ Day |**Yes**|
| **AutoRenew** | string | Whether to renew automatically, enumeration: Yes/ No |**Yes**|
| **IsExpire** | string | Whether the resource has expired, enumeration: Yes/ No |**Yes**|
| **ExpireTime** | int | Resource Expiration Timestamp |**Yes**|
| **TaskId** | string | Task ID |**Yes**|
| **Name** | string | Task Name |**Yes**|
| **Type** | string | Task Type, full for full backup, incremental for incremental backup, full+incremental for full plus incremental backup. |**Yes**|
| **MaxRetryCount** | int | Maximum Number of Retry Attempts |No|
| **CurRetryCount** | int | Current Failure Retry Count |No|
| **Status** | string | Task Status |No|
| **CreateTime** | int | Creation Time |No|
| **Progress** | [*Progress*](#progress) | Full migration progress information, empty during incremental migration |No|

#### Progress

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **TotalCount** | int | Total number of entries |No|
| **CurCount** | int | Number of Items Migrated |No|
| **TotalDuration** | int | Estimated Total Consumption Time (in seconds) |No|
| **CurDuration** | int | Elapsed Time (in seconds) |No|
| **Percentage** | float | Progress Completion |No|
| **RedisOffsetSize** | int | Redis Offset |No|
| **RedisDelayTime** | int | Redis Delay Time  Unit is Seconds |No|
| **MongoDelayTime** | int | Mongo delay time, in seconds |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListUDTSTask
&Limit=3
&Offset=0
&ProjectId=org-hiny12
&Type=EqMkhIbB
```

### Response Example
    
```json
{
  "Action": "ListUDTSTaskResponse",
  "Data": [
    {
      "CreateTime": 1559630077,
      "CurRetryCount": 0,
      "MaxRetryCount": 0,
      "Name": "test-1",
      "Progress": {
        "CurCount": 0,
        "CurDuration": 0,
        "Percentage": 0,
        "TotalCount": 0,
        "TotalDuration": 0
      },
      "Status": "Created",
      "TaskId": "udts-zzcsnrkx",
      "Type": "full"
    },
    {
      "CreateTime": 1559285642,
      "CurRetryCount": 0,
      "MaxRetryCount": 0,
      "Name": "test-1",
      "Progress": {
        "CurCount": 0,
        "CurDuration": 0,
        "Percentage": 0,
        "TotalCount": 0,
        "TotalDuration": 0
      },
      "Status": "Created",
      "TaskId": "udts-kjl55fxr",
      "Type": "full"
    }
  ],
  "Message": "",
  "RetCode": 0
}
```