刷新预热接口API文档

内容分发网络 刷新预热接口 API 文档

版权声明 2015-2016 腾讯云版权所有 本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制 修改 抄袭 传 播全部或部分本文档内容 商标声明 及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有 本文档涉及的第三方 主体的商标, 依法由权利人所有 服务声明 本文档意在向客户介绍腾讯云全部或部分产品 服务的当时的整体概况, 部分产品 服务的内容可能有所调整 您所购买的腾讯云产品 服务的种类 服务标准等应由您与腾讯云之间的商业合同约定, 除非双方另有约定, 否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证 第 2 页共 15 页

文档目录 文档声明... 2 刷新 URL... 4 刷新目录... 8 查询刷新记录... 12 第 3 页共 15 页

刷新 URL 1. 接口描述 本接口 (RefreshCdnUrl) 用于将节点上指定资源设置为过期 接口请求域名 :cdn.api.qcloud.com 1) 每一个用户每天的 URL 刷新限额为 10000 条 ; 2) 每一次最多可提交 1000 条 URL 进行刷新 2. 输入参数 以下请求参数列表仅列出了 接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数 页面 其中, 此接口的 Action 字段为 RefreshCdnUrl 参数名称是否必选类型描述 urls.n 是 String 需要刷新的 URL, 支持刷 新一个或多个 URL 注意事项 支持刷新一个或多个 URL, 刷新多个 URL 时, 参数传入方式可参考 : urls.0=http://www.abc.com/1.jpg&urls.1=http://www.abc.com/2.jpg 注意 URL 必须以 'http://' 或 'https://' 开头, 否则会报错 ; 提交刷新 URL 中的域名必须 为该用户已经接入 CDN 的域名, 且域名的状态为部署中或已启动, 否则会报错 ; 刷新 URL 若带有参数, 如 : 第 4 页共 15 页

https://www.abc.com/index.php?name=1 https://www.abc.com/index.php?name=2 此时会无视参数, 均刷新 URL:https://www.abc.com/index.php 3. 输出参数 参数名称 类型 描述 code Int 公共错误码,0 表示成功, 其他值表示失败 详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 codedesc String 英文错误信息, 或业务侧错误码 data Array 详细说明见下文 data 字段说明 : 参数名称类型描述 count Int 此次刷新提交的 URL 数目 4. 示例 4.1 输入示例 urls.0: https://www.test.com/1.jpg 4.2 GET 请求 第 5 页共 15 页

GET 请求需要将所有参数都加在 URL 后 : https://cdn.api.qcloud.com/v2/index.php? Action=RefreshCdnUrl &SecretId=XXXXXXXXXXXXXXXXXX &Timestamp=1462521223 &Nonce=123456789 &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX &urls.0=https%3a%2f%2www.test.com%2f1.jpg 4.3 POST 请求 POST 请求时, 参数填充在 HTTP Request-body 中, 请求地址 : https://cdn.api.qcloud.com/v2/index.php 参数支持 form-data x-www-form-urlencoded 等格式, 参数数组如下 : array ( 'Action' => 'RefreshCdnUrl', 'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'Timestamp' => 1462864833, 'Nonce' => 1149033341, 'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'urls.0' => 'https://www.test.com/1.jpg' ) 当需要刷新的 URL 较多时, 为避免 GET 请求长度超出限制, 建议使用 POST 方式调用此接口 4.4 返回结果示例 第 6 页共 15 页

刷新提交成功 { "code": 0, "message": "", "codedesc": "Success", "data": { "count": 1 刷新提交失败 { "code": 4000, "message": "(9110) 没有这个域名的信息 cdn no such host", "codedesc": "9110" PHP&Python 示例下载 示例代码 PHP&Python 新版 第 7 页共 15 页

刷新目录 1. 接口描述 本接口 (RefreshCdnDir) 用于将节点上指定资源目录下的内容设置为过期 接口请求域名 :cdn.api.qcloud.com 1) 每一个用户每天可以目录刷新的限额为 100 条 ; 2) 每一次最多可以提交 20 条 2. 输入参数 以下请求参数列表仅列出了 接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数 页面 其中, 此接口的 Action 字段为 RefreshCdnDir 参数名称是否必选类型描述 dirs.n 是 String 需要刷新的目录, 支持刷新 一个或多个目录 注意事项 支持一个或多个目录刷新 : dirs.0=http://www.test.com/abc/&dirs.1=http://www.test.com/def/ 注意 URL 必须以 'http://' 或 'https://' 开头, 否则会报错 3. 输出参数 参数名称类型描述 第 8 页共 15 页

参数名称 类型 描述 code Int 公共错误码,0 表示成功, 其他值表示失败 详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 codedesc String 英文错误信息, 或业务侧错误码 4. 示例 4.1 输入示例 dirs.0: http://www.test.com/test/ 4.2 GET 请求 GET 请求需要将所有参数都加在 URL 后 : https://cdn.api.qcloud.com/v2/index.php? Action=RefreshCdnDir &SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX &Timestamp=1462521628 &Nonce=123456789 &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX &dirs.0=https%3a%2f%2fwww.test.com%2fabc 4.3 POST 请求 POST 请求时, 参数填充在 HTTP Request-body 中, 请求地址 : https://cdn.api.qcloud.com/v2/index.php 第 9 页共 15 页

参数支持 form-data x-www-form-urlencoded 等格式, 参数数组如下 : array ( 'Action' => 'RefreshCdnDir', 'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXX', 'Timestamp' => 1462865178, 'Nonce' => 279749933, 'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'dirs.0' => 'http://www.test.com/test/' ) 4.4 返回结果示例 刷新提交成功 { "code": 0, "message": "", "codedesc": "Success" 刷新提交失败 { "code": 4000, "message": "(9110) 没有这个域名的信息 cdn no such host", "codedesc": 9110 第 10 页共 15 页

PHP&Python 示例下载 示例代码 PHP&Python 新版 第 11 页共 15 页

查询刷新记录 1. 接口描述 本接口 (GetCdnRefreshLog) 用于查询指定时间区间内的刷新日志 刷新次数, 可指定 URL 查询 接口请求域名 :cdn.api.qcloud.com 2. 输入参数 以下请求参数列表仅列出了 接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数 页面 其中, 此接口的 Action 字段为 GetCdnRefreshLog 参数名称 是否必选 类型 描述 startdate 是 String 查询开始时间 ( 日 ) enddate 是 String 查询结束时间 ( 日 ) url 否 String 需要查询的 URL( 可为空 ) 3. 输出参数 参数名称 类型 描述 code Int 公共错误码,0 表示成功, 其他值表示失败 详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 codedesc String 英文错误信息, 或业务侧错误码 data Array 返回结果数据 data 字段说明 参数名称类型描述 logs Array 日志详情 total Int 刷新次数 第 12 页共 15 页

logs 字段说明 参数名称 类型 描述 id Int 编号 app_id Int 用户 APP ID project_id Int 项目 ID host String 域名 type Int 刷新类型 共两种类型, 其中 0 代表 URL 刷新 ;1 代表目录刷新 ; status Int 刷新结果 ; 若为 1, 则表示刷新成功 url_list Array 本次刷新时提交的 URL 列表 datetime String 提交时间 4. 示例 4.1 输入示例 startdate: 20160503 enddate: 20160504 4.2 GET 请求 GET 请求需要将所有参数都加在 URL 后 : https://cdn.api.qcloud.com/v2/index.php? Action=GetCdnRefreshLog &SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX &Timestamp=1462422547 &Nonce=12345678 &Signature=XXXXXXXXXXXXXXXXXXXXXXXXX &startdate=20160503 &enddate=20160504 第 13 页共 15 页

4.3 POST 请求 POST 请求时, 参数填充在 HTTP Request-body 中, 请求地址 : https://cdn.api.qcloud.com/v2/index.php 参数支持 form-data x-www-form-urlencoded 等格式, 参数数组如下 : array ( 'Action' => 'GetCdnRefreshLog', 'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'Timestamp' => 1462782282, 'Nonce' => 123456789, 'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX', 'startdate' => '20160503', "enddate" => '20160504' ) 4.4 返回结果示例 { "retcode": 0, "errmsg": "ok", "code": 0, "message": "", "codedesc": "Success", "data": { "logs": [ { "id": 6182538, 第 14 页共 15 页

Powered by TCPDF (www.tcpdf.org) 刷新预热接口 API 文档 "app_id": 123456, "project_id": 0, "host": "www.test.com", "type": 0, "status": 1, "url_list": [ "http://www.test.com/content/image/test.png" ], "datetime": "2016-09-05 18:07:12", { "id": 6759919, "app_id": 123456, "project_id": 0, "host": "www.test.com", "type": 1, "status": 1, "url_list": [ "http://www.test.com/content/" ], "datetime": "2016-09-05 19:58:54" ], "total": 2 PHP&Python 示例下载 示例代码 PHP&Python 新版 第 15 页共 15 页