预热缓存接口

Size: px

Start display at page:

Download "预热缓存接口"

邑童
5 years ago
Views:

1 目录目录目录 PreloadCaches 描述请求语法请求参数返回参数示例 RefreshCaches 描述请求语法请求参数返回参数示例 GetRefreshOrPreloadTask 描述请求参数返回参数 Data 示例 GetRefreshOrPreloadQuota 描述请求语法返回参数示例目录金山云 1/11

2 内容管理接口 PreloadCach es 描述本接口用于将源站的内容主动预热到 Cache 节点上, 用户首次访问可直接命中缓存, 缓解源站压力 : 同一个 ID 每日设有提交预热类请求条数限制额度, 与控制台共享此额度, 具体额度可查看控制台或调用 GetRefreshOrPreloadQuota 接口获取刷新预热类接口包含 RefreshCaches 刷新接口和 PreloadCaches 预热接口注意 : 每个必须以或者开头每个最大长度 1000 字符每个所在的域名必须是该用户在金山云加速的域名如果包含中文字符, 请使用 urlencode 方式提交单次调用上限为 1000 条预热仅支持精确匹配, 不支持目录预热, 不支持正则匹配接口仅支持 POST 请求格式请求语法本接口请求需要包含指定目录 / /content/PreloadCaches 公共请求 header 和该接口所特有的请求参数, 具体请求语句参照下文请求示例请求参数 s 是 [] 需要预热的列表是 String 需要提交刷新的, 单条输入返回参数 PreloadTaskId String 预热返回的任务 ID 示例请求示例 POST JSON 方式 : 金山云 /11

3 内容管理接口 POST / /content/PreloadCaches 1.1 Content-Type:application/json Accept:application/json X-Action: PreloadCaches X-Version: "s": [ "": " "": " ] POST XML 方式 : POST / /content/PreloadCaches 1.1 Content-Type:application/xml Accept:application/xml X-Action: PreloadCaches X-Version: <PreloadCaches> <s> <> <> </s> </PreloadCaches> 返回示例 JSON 格式 : "PreloadTaskId": "7e9ac8dc640b891f54ed6b1c997" XML 格式 : <?xml version="1.0" encoding="utf-8" standalone="yes"?> <PreloadTask> <PreloadTaskId>fe4dd335ad1146e991a144d1a53fc1ea</PreloadTaskId> </PreloadTask> Refresh Cach es 描述金山云 3/11

4 内容管理接口本接口用于刷新节点上的文件内容刷新指定 URL 内容至 Cache 节点, 支持 URL 目录批量刷新 : 注意 : 每个 ID 每日设有提交刷新类请求条数限制额度, 与金山云 CDN 控制台共享此额度, 具体额度可查看控制台或调用 GetRefreshOrPreloadQuota 接口获取刷新预热类接口包含 RefreshCaches 刷新接口和 PreloadCaches 预热接口 Fil es 与 Dirs 必须至少指定一种, 可同时指定, 即文件刷新和目录刷新可同时进行每个必须以或者开头每个最大长度 1000 字符每个所在的域名必须是该用户在金山云加速的域名如果包含中文字符, 请使用 urlencode 方式提交单次调用文件类刷新上限为 1000 条, 目录类刷新上限为 30 条支持及目录精确匹配, 不支持正则匹配接口仅支持 POST 请求格式请求语法本接口请求需要包含指定目录 / /content/RefreshCaches 公共请求 header 和该接口所特有的请求参数, 具体请求语句参照下文请求示例请求参数 Files 否 [] 需要文件类型刷新的列表 Dirs 否 [] 需要目录类型刷新的列表是 String 需要提交刷新的, 单条输入返回参数 RefreshTaskId String 刷新返回的任务 ID 示例请求示例 POST JSON 方式 : 金山云 4/11

5 内容管理接口 POST / /content/RefreshCaches 1.1 x-action: RefreshCaches x-version: Content-Type:application/json Accept:application/json "Files": [ "": " "": " ], "Dirs": [ "": " "": " ] POST XML 方式 : POST / /content/RefreshCaches 1.1 Content-Type:application/xml Accept:application/xml X-Action: RefreshCaches X-Version: <RefreshCaches> <Files> <> <> </Files> <Dirs> <> <> </Dirs> </RefreshCaches> 返回示例 JSON 格式 : "RefreshTaskId": "ee67830fe814e49a4d0537fc7a16c1" XML 格式 : 金山云 5/11

6 内容管理接口 <?xml version="1.0" encoding="utf-8" standalone="yes"?> <RefreshTask> <RefreshTaskId>41bfa7b33164a639f0de80f8bb0cc34</RefreshTaskId> </RefreshTask> G et Refresh OrPreloadTask 描述本接口用于获取 URL 刷新目录刷新和预热任务进度百分比及状态, 查看任务是否在全网生效支持根据任务 ID URL 获取数据支持按指定的起止时间查询, 两者需要同时指定所有参数都不指定, 默认查 7 天内, 第一页的数据 (0 条 ) 起止时间 TaskId 可以同时指定, 逻辑与的关系最多可获取 7 天内的数据使用场景查询用户 URL 刷新目录刷新或预热 URL 进度百分比及状态, 查看是否在全网生效, 用于在控制台展示客户通过 API 获取 URL 刷新目录刷新或预热任务或 URL 进度百分比及状态, 查看是否在全网生效注意 : 接口仅支持 POST 请求格式请求参数类型及范围 StartT ime 否 String 获取数据起始时间点, 日期格式按 ISO8601 表示法, 北京时间, 格式为 :YYYY-MM-DDThh :mm+0800, 例如 : T1: EndTim e 否 String 结束时间需大于起始时间 ; 获取日期格式按照 ISO8601 表示法, 北京时间, 格式为 :YYY Y-MM-DDThh:mm+0800, 例如 : T1: TaskId 否 String 支持按任务 ID 查询, 只允许输入单个任务 ID s 否 [] 组成的数组, 支持按路径查询, 准确匹配 PageSi ze PageNu mber 否 Long 分页大小, 取值为 1-50, 最大 50, 默认 0 否 Long 取得第几页, 取值为 : , 最大 , 默认 1 是 String 需要查询的路径返回参数金山云 6/11

7 内容管理接口 PageSize Long 整页大小 PageNumber Long 页码 TotalCount Long 总条数 Datas Data[] 刷新或预热任务进度百分比及状态信息 Da ta Type 类型及范围 String 任务类别, 取值为 :refresh_url,url 刷新任务 ; 取值为 :refresh_dir, 目录刷新任务 ; 取值为 :preload, 预热任务 String 刷新或预热的地址 Progres s Double 刷新或预热任务进度百分比数值 Status String 刷新或预热状态信息, 取值分别是 success( 成功 ) Progressing( 进行中 ) Failed( 刷新失败 ) TaskId String 任务 ID, 按照任务 ID 查询刷新或预热任务进度百分比及状态信息 CreateT ime String 任务创建时间示例请求示例 POST JSON 方式 : POST / /content/GetRefreshOrPreloadTask 1.1 x-action: RefreshCaches x-version: Content-Type:application/json Accept:application/json "PageSize":1, "PageNumber":1, "s":[ "": " "": " ] POST XML 方式 : 金山云 7/11

8 内容管理接口 POST / /content/GetRefreshOrPreloadTask 1.1 Content-Type:application/xml Accept:application/xml X-Action: RefreshCaches X-Version: <RefreshCaches> <s> <> <> </s> </RefreshCaches> 返回示例 JSON 格式 : 金山云 8/11

9 内容管理接口 "s": [ "":" "":" ], "EndTime":" T17: ", "PageNumber":"1", "PageSize": "", "StartTime": " T01: ", "TaskId": "ee4d38ce6044d c774a4100" "StartTime": " T01: ", "EndTime": " T17: ", "TaskId": "ee4d38ce6044d c774a4100", "s": [ "": " "": " ], "PageSize":, "PageNumber": 1, "TotalCount":, "Datas": [ "Type": "refresh", "": " "Progress": 100, "Status": "success", "TaskId": "ee4d38ce6044d c774a4100", "CreateTime": " T14: ", "Type": "refresh", "": " "Progress": 100, "Status": "success", "TaskId": "ee4d38ce6044d c774a4100", "CreateTime": " T14: " ] XML 格式 : 金山云 9/11

10 内容管理接口 <?xml version="1.0" encoding="utf-8" standalone="yes"?> <ReSetProgressRequest> <StartTime> T01: </StartTime> <EndTime> T17: </EndTime> <TaskId>ee4d38ce6044d c774a4100</TaskId> <s> <> </s> <s> <> </s> <PageSize></PageSize> <PageNumber>1</PageNumber> <TotalCount></TotalCount> <Datas> <Type>refresh</Type> <> <Progress>100.0</Progress> <Status>success</Status> <TaskId>ee4d38ce6044d c774a4100</TaskId> <CreateTime/> </Datas> <Datas> <Type>refresh</Type> <> <Progress>100.0</Progress> <Status>success</Status> <TaskId>ee4d38ce6044d c774a4100</TaskId> <CreateTime/> </Datas> </ReSetProgressRequest> G et Refresh OrPreloadQu ot a 描述本接口用于获取刷新预热 URL 及目录的最大限制数量, 及当日剩余刷新预热 URL 及目录的条数 : 刷新预热类接口包含 RefreshCaches 刷新接口和 PreloadCaches 预热接口注意 : 接口仅支持 POST 请求格式请求语法本接口请求需要包含指定目录 / /content/GetRefreshOrPreloadQuota 公共请求 header 和该接口所特有的请求参数, 具体请求语句参照下文请求示例返回参数 RefreshQuota Long 文件刷新上限条数 RefreshDirQuota Long 目录刷新上限条数金山云 10/11

11 内容管理接口 PreloadQuota Long 预热上限条数 RefreshSurplus Long 当日剩余文件刷新条数 RefreshDirSurplus Long 当日剩余目录刷新条数 PreloadSurplus Long 当日剩余预热条数示例请求示例 GET 方式 : GET POST / /content/GetRefreshOrPreloadQuota 1.1 X-Action: GetRefreshOrPreloadQuota X-Version: 返回示例 JSON 格式 : "RefreshQuota": 10000, "RefreshDirQuota": 10000, "PreloadQuota": 10000, "RefreshSurplus": 9999, "RefreshDirSurplus": 9999, "PreloadSurplus": 9999 XML 格式 : <?xml version="1.0" encoding="utf-8" standalone="yes"?> <RefreshOrPreloadQuota> <RefreshQuota>10000</RefreshQuota> <RefreshDirQuota>10000</RefreshDirQuota> <PreloadQuota>10000</PreloadQuota> <RefreshSurplus>9999</RefreshSurplus> <RefreshDirSurplus>9999</RefreshDirSurplus> <PreloadSurplus>9999</PreloadSurplus> </RefreshOrPreloadQuota> 金山云 11/11

刷新预热接口API文档

刷新预热接口API文档内容分发网络刷新预热接口 API 文档版权声明 2015-2016 腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品