查询预热状态
更新时间：2023-10-16
接口描述
本接口用于查询指定条件的预热任务状态，精确查询返回所有记录，按照范围查询时最多返回100条记录。
请求结构
GET /v2/abroad/cache/prefetch?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<PrefetchStatus> | 提交的预热任务详情。 |
| isTruncated | Bool | true表示该查询范围内后面还有数据，false表示已经是最后一页。 |
| nextMarker | String | 当isTruncated为false时，该域不出现。用户通过在下次调用本接口时指定该marker标记来获取后续的列表。 |
PrefetchStatus类型说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| task | PrefetchTask | 提交的预热任务。 |
| createdAt | Timestamp | 预热任务的创建时间，UTC时间。 |
| status | String | 预热任务状态，取值为completed、failed和in-progress。 |
说明: 和国内版不同，此处没有进度的概念，只有completed、failed和in-progress这3个状态。
PrefetchTask类型说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| url | String | 预热的具体url。 |
| type | String | 预热任务类型，目前仅有file类型。 |
请求示例
精确查询
GET /v2/abroad/cache/prefetch?id=eJwNyMERABAMBMCKMnPicH5aiQz9l8A+l61VAFwqk9ToFrjbiBIWqbT0n76lQ3/vTArw HTTP/1.1
Host: cdn.baidubce.com范围查询
GET /v2/abroad/cache/prefetch?startTime=2023-03-06T02:00:00Z&endTime=2023-03-07T02:00:00Z HTTP/1.1
Host: cdn.baidubce.com查询指定时间范围的下一页
GET /v2/abroad/cache/prefetch?startTime=2023-03-06T02:00:00Z&endTime=2023-03-07T02:00:00Z&marker=eJwFwcERwCAIBMCKmBG5yPmzFROO/kvILuCRDh5Wv1S0YTANpTau8Vls1AwnIJ7ufDijpJ3p3veT2rnuJVWpHxiZFRk= HTTP/1.1
Host: cdn.baidubce.com响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 21 Jun 2023 06:57:40 GMT
x-bce-request-id: b5dc6aae-6e06-d8fa-433b-5043dbfbcdd5
Server: BCE-CDN
{
"details": [
{
"task": {
"url": "http://my.domain.com/1.txt",
"type": "file"
},
"createdAt": "2023-03-06T10:00:00Z",
"status": "completed"
},
{
"task": {
"url": "http://my.domain.com/2.txt",
"type": "file"
},
"createdAt": "2023-03-06T10:00:00Z",
"status": "completed"
}
],
"isTruncated": true,
"nextMarker":"eJwFwcERwCAIBMCKmBG5yPmzFROO/kvILuCRDh5Wv1S0YTANpTau8Vls1AwnIJ7ufDijpJ3p3veT2rnuJVWpHxiZFRk="
}