# 获取 Task 列表信息 - ListUDTSTask

## 简介

获取用户创建的 Task 信息





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `ListUDTSTask`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.sigcalcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **Offset** | string | 偏移量，默认为 0 |No|
| **Limit** | string | 请求数量，默认为 20 |No|
| **Type** | string | 任务类型 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **Data** | array[[*ListDataItem*](#ListDataItem)] | ListDataItem 数组 |**Yes**|

#### 数据模型


#### ListDataItem

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ServiceType** | string | 服务类型， small, medium, large  |**Yes**|
| **ChargeType** | string | 资源付费类型，枚举：Dynamic/ Month/ Year/ Trial/ Day |**Yes**|
| **AutoRenew** | string | 是否自动续费，枚举：Yes/ No  |**Yes**|
| **IsExpire** | string | 资源是否过期，枚举：Yes/ No   |**Yes**|
| **ExpireTime** | int | 资源有效期时间戳 |**Yes**|
| **TaskId** | string | 任务 ID |**Yes**|
| **Name** | string | 任务名称 |**Yes**|
| **Type** | string | 任务类型, full全量, incremental增量，full+incremental全量+增量。 |**Yes**|
| **MaxRetryCount** | int | 最大失败重试次数 |No|
| **CurRetryCount** | int | 当前失败重试次数 |No|
| **Status** | string | 任务状态 |No|
| **CreateTime** | int | 创建时间 |No|
| **Progress** | [*Progress*](#Progress) | 全量迁移进度信息，增量迁移时为空  |No|

#### Progress

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **TotalCount** | int | 总条目数 |No|
| **CurCount** | int | 已迁移条目数 |No|
| **TotalDuration** | int | 估算总耗时间（单位秒） |No|
| **CurDuration** | int | 已耗时间（单位秒） |No|
| **Percentage** | float | 完成进度 |No|
| **RedisOffsetSize** | int | Redis偏移量 |No|
| **RedisDelayTime** | int | Redis延迟时间  单位为秒   |No|
| **MongoDelayTime** | int | Mongo延迟时间，单位为秒  |No|

## 示例

### 请求示例
    
```
https://api.sigcalcloud.com/?Action=ListUDTSTask
&Limit=3
&Offset=0
&ProjectId=org-hiny12
&Type=EqMkhIbB
```

### 响应示例
    
```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
}
```