创建刷新缓存任务
功能介绍
创建刷新缓存任务。
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
当用户开启企业项目功能时,该参数生效,表示在当前企业项目下添加缓存刷新任务,"all"代表所有项目。注意:当使用子账号调用接口时,该参数必传。 |
请求消息
请求参数
请求参数如表2所示。
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
刷新的类型, 其值可以为file 或directory,默认为file。 |
urls |
是 |
Array of strings |
输入示例:http://abc.com/image/1.png,多个URL之间需要用逗号分隔,单个url的长度限制为10240字符,单次最多输入1000个url。 |
请求示例
请求路径示例
{ "refreshTask":{ "type":"file", "urls":[ "http://www.example.com/index.html", "http://www.example.com/web" ] } }
响应消息
响应参数
响应参数如表3所示。
名称 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务id。 |
task_type |
String |
任务的类型, 其值可以为refresh或preheating。 |
status |
String |
刷新结果。task_done表示刷新成功 ,task_inprocess表示刷新中。 |
processing |
Integer |
处理中的url个数。 |
succeed |
Integer |
成功处理的url个数。 |
failed |
Integer |
处理失败的url个数。 |
total |
Integer |
总共的任务个数。 |
create_time |
Integer |
任务创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 |
urls |
Array of strings |
刷新缓存的url列表。 |
{ "refreshTask" : { "id" : "ff808***********************2b35", "status" : "task_inprocess", "processing" : 2, "succeed" : 0, "failed" : 0, "urls" : [ "http://www.example1.com/index.html", "http://www.example2.com/web" ], "task_type" : "refresh", "total" : 2, "create_time" : 0 } }
状态码
状态码请参见状态码。
错误码
请参见错误码。