预热缓存接口

1 3 3 4 4 4 4 4 6 6 6 6 6 7 7 10 10 10 10 11 目录目录目录 PreloadCaches 描述请求语法请求参数 返回参数示例 RefreshCaches 描述请求语法请求参数 返回参数示例 GetRefreshOrPreloadTask 描述请求参数 返回参数 Data 示例 GetRefreshOrPreloadQuota 描述请求语法返回参数示例目录 018-04-1 金山云 1/11

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

内容管理接口 018-04-1 POST /016-09-01/content/PreloadCaches 1.1 Content-Type:application/json Accept:application/json X-Action: PreloadCaches X-Version: 016-09-01 "s": [ "": "http://test.dxz.ksyun.8686c.com/1.html", "": "http://111111111.com/.html" ] POST XML 方式 : POST /016-09-01/content/PreloadCaches 1.1 Content-Type:application/xml Accept:application/xml X-Action: PreloadCaches X-Version: 016-09-01 <PreloadCaches> <s> <>http://test.dxz.ksyun.8686c.com/1.html</> <>http://111111111.com/.html</> </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

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

内容管理接口 018-04-1 POST /016-09-01/content/RefreshCaches 1.1 x-action: RefreshCaches x-version: 016-09-01 Content-Type:application/json Accept:application/json "Files": [ "": "http://test.dxz.ksyun.8686c.com/abc.txt", "": "http://test.dxz.ksyun.8686c.com/test" ], "Dirs": [ "": "http://test.dxz.ksyun.8686c.com/abc", "": "http://test.dxz.ksyun.8686c.com/def" ] POST XML 方式 : POST /016-09-01/content/RefreshCaches 1.1 Content-Type:application/xml Accept:application/xml X-Action: RefreshCaches X-Version: 016-09-01 <RefreshCaches> <Files> <>http://test.dxz.ksyun.8686c.com/abc.txt</> <>http://test.dxz.ksyun.8686c.com/abcd.txt</> </Files> <Dirs> <>http://test.dxz.ksyun.8686c.com/abc</> <>http://test.dxz.ksyun.8686c.com/abcd</> </Dirs> </RefreshCaches> 返回示例 JSON 格式 : "RefreshTaskId": "ee67830fe814e49a4d0537fc7a16c1" XML 格式 : 金山云 5/11

内容管理接口 018-04-1 <?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, 例如 :016-08-01T1:14+0800 EndTim e 否 String 结束时间需大于起始时间 ; 获取日期格式按照 ISO8601 表示法, 北京时间, 格式为 :YYY Y-MM-DDThh:mm+0800, 例如 :016-08-01T1:14+0800 TaskId 否 String 支持按任务 ID 查询, 只允许输入单个任务 ID s 否 [] 组成的数组, 支持按 路径查询, 准确匹配 PageSi ze PageNu mber 否 Long 分页大小, 取值为 1-50, 最大 50, 默认 0 否 Long 取得第几页, 取值为 :1-100000, 最大 100000, 默认 1 是 String 需要查询的 路径 返回参数 金山云 6/11

内容管理接口 018-04-1 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 /016-09-01/content/GetRefreshOrPreloadTask 1.1 x-action: RefreshCaches x-version: 016-09-01 Content-Type:application/json Accept:application/json "PageSize":1, "PageNumber":1, "s":[ "": "http://test.dxz.ksyun.8686c.com/l/", "": "http://test.dxz.ksyun.8686c.com/abc.txt" ] POST XML 方式 : 金山云 7/11

内容管理接口 018-04-1 POST /016-09-01/content/GetRefreshOrPreloadTask 1.1 Content-Type:application/xml Accept:application/xml X-Action: RefreshCaches X-Version: 016-09-01 <RefreshCaches> <s> <>http://test.dxz.ksyun.8686c.com/abc.txt</> <>http://test.dxz.ksyun.8686c.com/abcd.txt</> </s> </RefreshCaches> 返回示例 JSON 格式 : 金山云 8/11

内容管理接口 018-04-1 "s": [ "":"http://www.superb.6.baidu.com/b", "":"http://www.superb.6.baidu.com/b1" ], "EndTime":"017-0-17T17:04+0800", "PageNumber":"1", "PageSize": "", "StartTime": "017-0-14T01:1 4+0800", "TaskId": "ee4d38ce6044d7688140c774a4100" "StartTime": "017-0-14T01:14+0800", "EndTime": "017-0-17T17:04+0800", "TaskId": "ee4d38ce6044d7688140c774a4100", "s": [ "": "http://www.superb.6.baidu.com/b", "": "http://www.superb.6.baidu.com/b1" ], "PageSize":, "PageNumber": 1, "TotalCount":, "Datas": [ "Type": "refresh", "": "http://www.superb.6.baidu.com/b1", "Progress": 100, "Status": "success", "TaskId": "ee4d38ce6044d7688140c774a4100", "CreateTime": "017-0-16T14:41+0800", "Type": "refresh", "": "http://www.superb.6.baidu.com/b", "Progress": 100, "Status": "success", "TaskId": "ee4d38ce6044d7688140c774a4100", "CreateTime": "017-0-16T14:41+0800" ] XML 格式 : 金山云 9/11

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

内容管理接口 018-04-1 PreloadQuota Long 预热 上限条数 RefreshSurplus Long 当日剩余文件刷新 条数 RefreshDirSurplus Long 当日剩余目录刷新 条数 PreloadSurplus Long 当日剩余预热 条数 示例 请求示例 GET 方式 : GET POST /016-09-01/content/GetRefreshOrPreloadQuota 1.1 X-Action: GetRefreshOrPreloadQuota X-Version: 016-09-01 返回示例 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