# View Service Status - GetUDTSTaskStatus

## Overview

View Service Status






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetUDTSTaskStatus`.                      | **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|
| **TaskId** | string | Task ID |**Yes**|
| **Type** | string | Task type, value is either 'transfer' or 'integration'. When it's 'transfer', the task is 'Data Migration'. When it's 'integration', the task is 'Data Integration'. |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** | [*StatusData*](#statusdata) | StatusData |No|

#### Data Model


#### StatusData

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **MaxRetryCount** | int | The maximum number of failure retries set by the user |No|
| **Status** | string | Task Status, the statuses are Created: Created, Checking: Checking, Dumping: Dumping, Loading: Loading, Syncing: Syncing, Synced: Synced, Done: Done, Failed: Failed, Stopping: Stopping, Stopped: Stopped, RetryPending: Retry Pending, Starting: Starting, FailedUnrecoverable: Unrecoverable Failure, StoppedUnrecoverable: Unrecoverable Stop, Success: Success, Started: Started |No|
| **FailedMessage** | string | When the Status is 'Failed', display the failure reason. |No|
| **CurRetryCount** | int | Current Failure Retry Count |No|
| **Progress** | [*Progress*](#progress) | Progress full migration progress information, empty when the type is incremental migration |No|
| **Sync** | [*SyncData*](#syncdata) | Binlog Information |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|

#### SyncData

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BinlogName** | string | Binlog file name, length does not exceed 128 characters |No|
| **BinlogPos** | int | Binlog Pos |No|
| **BinlogGTID** | string | GTID |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=GetUDTSTaskStatus
&ProjectId=org-hiny12
&TaskId=udts-ixdp441
&Type=YJymvzTG
```

### Response Example
    
```json
{
  "Action": "GetUDTSTaskStatusResponse",
  "Data": {
    "CurRetryCount": 0,
    "MaxRetryCount": 0,
    "Progress": {
      "CurCount": 0,
      "CurDuration": 0,
      "Percentage": 0,
      "TotalCount": 0,
      "TotalDuration": 0
    },
    "Status": "Done",
    "Sync": {
      "BinlogName": "mysql-bin.000006",
      "BinlogPos": 154
    }
  },
  "Message": "",
  "RetCode": 0
}
```