更新时间:2024-04-12 GMT+08:00

创建刷新缓存任务

功能介绍

创建刷新缓存任务。

URI

POST /v1.0/cdn/content/refresh-tasks

表1 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示在当前企业项目下添加缓存刷新任务,"all"代表所有项目。注意:当使用子帐号调用接口时,该参数必传。

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

refresh_task

RefreshTaskRequestBody object

缓存刷新设置。

表4 RefreshTaskRequestBody

参数

是否必选

参数类型

描述

type

String

刷新的类型,其值可以为file:文件,或directory:目录,默认为file。

mode

String

目录刷新方式,all:刷新目录下全部资源;detect_modify_refresh:刷新目录下已变更的资源。默认值为all。

zh_url_encode

Boolean

是否对url中的中文字符进行编码后刷新,false代表不开启,true代表开启,开启后仅刷新转码后的URL。

urls

Array of strings

需要刷新的URL必须带有“http://”或“https://”,多个URL用逗号分隔,单个url的长度限制为4096字符,单次最多输入1000个url,如果输入的是目录,支持100个目录刷新。

说明:

如果您需要刷新的URL中有中文,请同时刷新中文URL和转码后的URL。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

refresh_task

String

任务ID。

请求示例

POST https://cdn.myhuaweicloud.com/v1.0/cdn/content/refresh-tasks?enterprise_project_id=0

{
  "refresh_task" : {
    "type" : "file",
    "urls" : [ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt" ]
  }
}

响应示例

状态码: 200

OK

{
  "refresh_task" : "7620242"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码