查询刷新状态
更新时间：2023-07-17
接口描述
本接口用于查询指定条件的刷新任务状态，精确查询时返回所有记录，按照范围查询时最多返回100条记录。
请求结构
GET /v2/cache/purge?id=xxx&startTime=xxx&endTime=xxx&url=xxx&marker=xxx HTTP/1.1
Host: cdn.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
Query参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| id | string | 否 | 查询指定刷新任务的id。 |
| endTime | timestamp | 否 | 查询的时间范围结束值。默认为当前时间，UTC时间。 |
| startTime | timestamp | 否 | 查询的时间范围起始值。默认为endTime前推24小时，UTC时间，endTime与startTime最大时间跨度为30天。 |
| url | string | 否 | 查询指定url的刷新请求。 |
| marker | string | 否 | 用户上次调用本接口返回的nextMarker值，作为本次查询的起点。注：传该参数时，时间参数和上次查询保持一致，不传id参数。 |
查询类型：
- 精确查询：指定任务id，返回该任务所有记录。无需指定时间，不支持url和marker参数。
- 范围查询：指定时间参数，url参数可选，返回该时间范围内的任务记录。当需要返回下一页时，查询的时间范围不可改变，marker参数必填。
响应头域
除公共头域外，无其它特殊头域。
响应参数
响应体
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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时间。 |
| startedAt | timestamp | 表示刷新任务开始执行的时间，UTC时间。 |
| finishedAt | timestamp | 表示刷新任务的结束时间，UTC时间。结束可能是Completed、Failed，如果任务未结束，则不返回该项。 |
| progress | int | 表示进度百分比。 |
PurgeTask类型说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| url | string | 刷新的url。 |
| type | string | 刷新的类型：file、directory，默认为file。 |
请求示例
精确查询
GET /v2/cache/purge?id=eJwNyMERABAMBMCKMnPicH5aiQz9l8A+l61VAFwqk9ToFrjbiBIWqbT0n76lQ3/vTArw HTTP/1.1
Host: cdn.baidubce.com范围查询
GET /v2/cache/purge?startTime=2022-03-06T02:00:00Z&endTime=2022-03-07T02:00:00Z HTTP/1.1
Host: cdn.baidubce.com查询指定时间范围的下一页
GET /v2/cache/purge?startTime=2022-03-06T02:00:00Z&endTime=2022-03-07T02:00:00Z&marker=eJwFwcERwCAIBMCKmBG5yPmzFROO/kvILuCRDh5Wv1S0YTANpTau8Vls1AwnIJ7ufDijpJ3p3veT2rnuJVWpHxiZFRk= HTTP/1.1
Host: cdn.baidubce.com响应示例
HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
"details":
[
{
"status": "completed",
"createdAt": "2015-08-24T12:20:32Z",
"finishedAt": "2015-08-24T12:21:45Z",
"progress": 100,
"task":
{
"url": "http://my.domain.com/path/to/purge/1.data"
}
}
{
"status": "in-process",
"createdAt": "2015-08-24T12:20:32Z",
"finishedAt": "2015-08-24T12:21:49Z",
"progress": 87,
"task":
{
"url": "http://my.domain.com/path/to/purge/dir",
"type": "directory"
}
}
]，
"isTruncated": true,
"nextMarker":"eJwFwcERwCAIBMCKmBG5yPmzFROO/kvILuCRDh5Wv1S0YTANpTau8Vls1AwnIJ7ufDijpJ3p3veT2rnuJVWpHxiZFRk="
}