# Get domain refresh task status - DescribeNewUcdnRefreshCacheTask

## Overview

Get domain refresh task status






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeNewUcdnRefreshCacheTask`.                      | **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.N** | string | The task ID returned when submitting a task |No|
| **BeginTime** | int | The start time of the query, in Unix Timestamp format. If there is an EndTime, BeginTime must be assigned. |No|
| **EndTime** | int | The end time of the query, in Unix Timestamp format. EndTime defaults to the current time, and BeginTime defaults to the time one day before the current time. |No|
| **Status** | string | The status of the content that needs to be refreshed, enumeration values: success: successful; wait: waiting for processing; process: processing; failure: failure; unknow: unknown, all statuses are selected by default. |No|
| **Offset** | int | Data offset, default is 0, natural number |No|
| **Limit** | int | Return data length, default is all, natural number |No|
| **IsDcdn** | boolean | Whether to accelerate the whole site by default false |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|
| **TotalCount** | int | The total number of refresh tasks |No|
| **TaskList** | array[[*TaskInfo*](#taskinfo)] | Refresh task information, refer to TaskInfo |No|

#### Data Model


#### TaskInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **TaskId** | string | The task ID returned when submitting a task |No|
| **UrlLists** | array[[*UrlProgressInfo*](#urlprogressinfo)] | Information list of task url, refer to UrlProgressInfo |No|
| **CreateTime** | int | The time the refresh task was created. The format is Unix Timestamp. |No|
| **Status** | string | Refresh the current status of the task, enumeration values: success: Success; wait: Queuing; process: Processing; failure: Failure; unknow: Unknown |No|

#### UrlProgressInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Url** | string | Single URL to refresh |No|
| **CreateTime** | int | The time the refresh task was created. The format is Unix Timestamp. |No|
| **FinishTime** | int | Task completion time. Format is Unix Timestamp. |No|
| **Status** | string | Refresh the current status of the task, enumeration values: success: Success; wait: Queuing; process: Processing; failure: Failure; unknow: Unknown |No|
| **Progress** | int | Refresh progress, unit % |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=DescribeNewUcdnRefreshCacheTask
&ProjectId=xxxxxx
&TaskId.n=sHemHKgw
&BeginTime=2
&EndTime=6
&Status=JNhEgMiG
&Offset=3
&Limit=9
&IsDcdn=true
```

### Response Example
    
```json
{
  "Action": "DescribeNewUcdnRefreshCacheTaskResponse",
  "RetCode": 0,
  "TaskList": [
    {
      "CreateTime": 1548051097,
      "Status": "success",
      "TaskId": "20190121141137_4d8031d5",
      "Type": "file",
      "UrlLists": [
        {
          "CreateTime": 1548051097,
          "FinishTime": 1548051103,
          "Progress": 100,
          "Status": "success",
          "Url": "http://xxxxx/test2.jpg"
        },
        {
          "CreateTime": 1548051097,
          "FinishTime": 1548051103,
          "Progress": 100,
          "Status": "success",
          "Url": "http://xxxxx/test.jpg"
        }
      ]
    }
  ],
  "TotalCount": 2
}
```