> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cdn/purge/describepurgetask.md).

# DescribePurgeTask

## 1. API Description

This interface is used to check if the purge status is effective across the entire network.

## 2. Request Parameters

The following request parameters list only includes the required parameters for the interface.

| Parameter Name | Required | Type   | Description   |
| -------------- | -------- | ------ | ------------- |
| taskId         | Yes      | String | Purge task id |

## 3. Output Parameters

| Parameter Name | Type                                                                                                             | Description                                                                                 |
| -------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| requestId      | String                                                                                                           | Unique request ID, returned with each request. Provide this requestId when locating issues. |
| dataSet        | Array of [PurgeResultInfo](https://docs.console.zenlayer.com/api-reference/cdn/datastructure.md#purgeresultinfo) | Result set.                                                                                 |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}

1. **Query Purge Result**

```json
POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: DescribePurgeTask
<Common Request Params>

Request:
{
  "taskId": "taskId-xxxxxxx"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "dataSet": [
      {
        "path": "http://cdntest.zenlayer.com/dir/1.jpg",
        "status": "Success",
        "createTime": "2022-09-08T12:00:00.000Z",
        "updateTime": "2022-09-08T12:00:01.000Z"
      },
      {
        "path": "http://cdntest.zenlayer.com/dir/2.jpg",
        "status": "Success",
        "createTime": "2022-09-08T12:00:00.000Z",
        "updateTime": "2022-09-08T12:00:01.000Z"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see [Common Error Codes](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode.md).
