最近更新时间:2022-05-11 15:56:58
本接口用于获取URL刷新、目录刷新和预热任务进度百分比及状态,查看任务是否在全网生效。
相对于旧接口(2016-09-01版),本接口(2021-12-01版)除了支持根据任务ID、域名、Urls获取数据,还支持根据内容管理任务的类型Type和SubType获取数据
必须按指定的起止时间查询,两者需要同时指定
单次查询的时间跨度最长是10分钟,比如 StartTime是 2022-03-10T21:00+0800,那么 EndTime是不能大于2022-03-10T21:10+0800
单次查询任务最大返回500w条,超过10w条,TotalCount返回为100000,但可通过指定PageNumber去查看10w条以外的数据
起止时间、TaskId、域名、Urls、Type、SubType可以同时指定,逻辑与的关系;其中,起止时间为必选参数,TaskId、Urls、Type三个可选参数至少选一个
最多可获取3天内的数据,例如您当前的查询时间为2022-03-13-16:00,则您获取的数据起始时间最早为2022-03-10-16:00
使用场景
注意:
本接口请求需要包含指定目录/2021-12-01/content/GetRefreshOrPreloadTask、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。
参数名 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
StartTime | 是 | String | 获取数据起始时间点,不能超出可查询范围的起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2022-03-10T21:00+0800 |
EndTime | 是 | String | 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2022-03-10T21:10+0800 |
TaskId | 否 | String | 支持按任务ID查询,只允许输入单个任务ID |
DomainName | 否 | String | 支持按域名查询,只允许输入单个域名 |
Urls | 否 | Url[] | Url组成的数组,支持按Url路径查询,准确匹配 |
Type | 否 | String | 支持按内容管理任务的类型查询,传参可取值:refresh、preload。其中,refresh表示刷新任务类型,preload表示预热任务类型,不传参表示查询所有类型。 |
SubType | 否 | String | 支持按任务的细分类型查询,传参可取值:REFRESH_FILE、REFRESH_DIR。若Type取值refresh或者不传参,则该传参可生效,其中,REFRESH_FILE表示URL刷新,REFRESH_DIR表示目录刷新,不传参表示查询所有细分类型。若Type取值preload,则该参数为无效参数 |
PageSize | 否 | Long | 分页大小,取值为1-50,最大50,默认20 |
PageNumber | 否 | Long | 取得第几页,取值为:1-100000,最大100000,默认1 |
参数名 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
Url | 是 | String | 需要查询的Url路径 |
参数名 | 类型及范围 | 说明 |
---|---|---|
StartTime | String | 开始时间 |
EndTime | String | 结束时间 |
Urls | Url[] | 查询的URL列表 |
PageSize | Long | 整页大小 |
PageNumber | Long | 页码 |
TotalCount | Long | Url总条数 |
Datas | UrlData[] | 刷新或预热任务进度百分比及状态信息 |
参数名 | 类型及范围 | 说明 |
---|---|---|
Url | String | 需要查询进度的url |
参数名 | 类型及范围 | 说明 |
---|---|---|
Type | String | 任务类别,取值为:refresh,刷新任务;取值为:preload,预热任务 |
SubType | String | 任务的细分类型,取值为:REFRESH_FILE表示URL刷新,REFRESH_DIR表示目录刷新,PRELOAD_FILE表示URL预热。注:PRELOAD_FILE不在请求传参SubType的取值范围里,单纯作为响应的类型值 |
Url | String | 刷新或预热的Url地址 |
Progress | Double | 刷新或预热任务进度百分比数值 |
Status | String | 刷新或预热状态信息,取值分别是success(成功)、progressing(进行中)、failed(刷新失败) |
TaskId | String | 任务ID,按照任务ID查询刷新或预热任务进度百分比及状态信息 |
CreateTime | String | 任务创建时间 |
请求示例
POST方式
POST /2021-12-01/content/GetRefreshOrPreloadTask
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetRefreshOrPreloadTask
x-version: 2021-12-01
Content-Type:application/json
Accept:application/json
{
"StartTime": "2022-05-10T14:30+0800",
"EndTime": "2022-05-10T14:40+0800",
"Type": "refresh",
"SubType": "REFRESH_DIR"
}
返回示例
{
"StartTime": "2022-05-10T18:20+0800",
"EndTime": "2022-05-10T18:30+0800",
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 4,
"Datas": [
{
"Type": "refresh",
"SubType": "REFRESH_DIR",
"Url": "https://test-remove24.ksc-test.com/7772.a",
"Progress": 22.45,
"Status": "progressing",
"TaskId": "dd20d29f-c390-42f0-8fa5-019cdb7e2c86",
"CreateTime": "2022-05-10T18:21+0800"
},
{
"Type": "refresh",
"SubType": "REFRESH_DIR",
"Url": "https://test-remove24.ksc-test.com/666.a",
"Progress": 22.45,
"Status": "progressing",
"TaskId": "dd20d29f-c390-42f0-8fa5-019cdb7e2c86",
"CreateTime": "2022-05-10T18:21+0800"
},
{
"Type": "refresh",
"SubType": "REFRESH_DIR",
"Url": "https://test-remove24.ksc-test.com/7772.a",
"Progress": 25.04,
"Status": "progressing",
"TaskId": "503e0a4c-7bfc-4f64-9c50-dd9d333bb481",
"CreateTime": "2022-05-10T18:21+0800"
},
{
"Type": "refresh",
"SubType": "REFRESH_DIR",
"Url": "https://test-remove24.ksc-test.com/666.a",
"Progress": 25.18,
"Status": "progressing",
"TaskId": "503e0a4c-7bfc-4f64-9c50-dd9d333bb481",
"CreateTime": "2022-05-10T18:21+0800"
}
]
}
纯净模式