查询刷新状态
更新时间：2023-10-16
接口描述
本接口用于查询指定条件的刷新任务状态。
请求结构
Plain Text
1GET /v2/abroad/cache/purge?id=xxx&startTime=xxx&endTime=xxx&url=xxx&marker=xxx HTTP/1.1
2Host: cdn.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
Query参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| id | string | 否 | 查询指定刷新任务的id。 |
| endTime | timestamp | 否 | 查询的时间范围结束值。默认为当前时间，UTC时间。 |
| startTime | timestamp | 否 | 查询的时间范围起始值。默认为endTime前推15天，UTC时间。 |
| url | string | 否 | 查询指定url的刷新请求。 |
| marker | string | 否 | 用户上次调用本接口返回的nextMarker值，作为本次查询的起点。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
响应体
| 参数名称 | 类型 | 描述 |
|---|---|---|
| details | list<PurgeStatus> | 提交的刷新任务详情。 |
| isTruncated | bool | true表示该查询范围内后面还有数据，false表示已经是最后一页。 |
| nextMarker | string | 当isTruncated为false时，该域不出现。用户通过在下次调用本接口时指定该marker标记来获取后续的列表。 |
PurgeStatus类型说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | string | 取值为in-progress、completed、failed。 |
| task | list<PurgeTask> | task信息。 |
| createdAt | timestamp | 表示刷新任务的创建时间，UTC时间。 |
| finishedAt | timestamp | 表示刷新任务的结束时间，UTC时间。 |
PurgeTask类型说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| url | string | 刷新的url。 |
| type | string | 刷新的类型：file、directory，默认为file。 |
说明: 和国内版不同，此处没有进度的概念，只有completed、failed和in-progress这3个状态。
请求示例
JSON
1GET /v2/abroad/cache/purge HTTP/1.1
2Host: cdn.baidubce.com响应示例
JSON
1HTTP/1.1 200 OK
2Server: nginx/1.1.10
3Date: Fri, 13 Oct 2023 08:16:57 GMT
4Content-Type: application/json; charset=utf-8
5Transfer-Encoding: chunked
6Connection: keep-alive
7x-bce-request-id: b63d9e7d-6dd7-9f29-1cc1-9727e3bd2c97
8
9{
10 "details": [
11 {
12 "task": {
13 "url": "http://www.example.com/test.jpg",
14 "type": "file"
15 },
16 "createdAt": "2020-07-07T09:46:58Z",
17 "finishedAt": "2020-07-07T09:46:58Z",
18 "status": "completed"
19 },
20 {
21 "task": {
22 "url": "http://www.example.com/a/",
23 "type": "file"
24 },
25 "createdAt": "2020-07-07T09:45:32Z",
26 "finishedAt": "2020-07-07T09:45:32Z",
27 "status": "completed"
28 }
29 ],
30 "isTruncated": false
31}