1. 请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action |
String |
是 |
DescribeRefreshTasks |
公共参数,查询CDN预热刷新状态。取值:DescribeRefreshTasks |
TaskId |
String |
是 |
70422**** |
按任务ID查询预热或刷新状态。 |
Offset |
Integer |
否 |
20 |
分页查询偏移量,默认0,最多5000。 |
Limit |
Integer |
否 |
100 |
分页查询限制数目,默认20,最大可设置为100。 |
TaskType |
String |
是 |
file |
任务类型。取值范围: • file:文件刷新。 • directory:目录刷新。 • preload:文件预热。 |
2. 返回参数
名称 |
类型 |
示例 |
描述 |
Offset |
Integer |
20 |
分页查询偏移量,默认为0,最大为5000。 |
Limit |
Integer |
100 |
分页查询限制数目,默认20,最大可设置为100。 |
TotalCount |
Long |
2 |
总条数 |
Tasks |
Array of Task |
|
Task组成的Task任务列表 |
Task参数
字段 |
类型 |
描述 |
Status |
String |
预热刷新状态 |
TaskId |
String |
任务ID |
ObjectPath |
String |
文件URL |
ObjectType |
String |
文件类型 |
TaskType |
String |
任务类型 |
CreationTime |
String |
操作时间 |
3. 示例
3.1 请求示例
curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeRefreshTasks' \
-H 'Content-Type: application/json' \
-d '{"TaskId":"Iz8y8NpMcjcSdNcQe3CRc3KMb28z8NpMcPKPd34Udj8VcNOScN4SdPcP8oQ","TaskType":"file"}'
3.2 返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"ResponseData": {
"Offset": 0,
"Limit": 20,
"TotalCount": 1,
"Tasks": [
{
"Status": "Failed",
"TaskId": xxx,
"ObjectPath": "https://1121.kcdntestadd.kuaishou.com/testPreloadFile_11261424_1.txt",
"TaskType": "preload",
"ObjectType": "File",
"CreationTime": "2021-11-28T02:00:52Z"
}
]
},
"ResponseMeta": {
"RequestId": "CmCmkWGi-0IAAAAAAAAA6Q",
"ErrorCode": "",
"ErrorMessage": ""
}
}
4. 错误码
错误代码 |
错误信息 |
HTTP 状态码 |
说明 |
InvalidArgument.InvalidTaskId |
Specified TaskId is invalid. |
400 |
TaskId格式错误。 |