刷新记录查询

最近更新时间:2018-05-09 17:36:51

接口描述

GetCdnRefreshLog 查询提交的刷新URL、刷新目录任务执行情况。

请求域名:cdn.api.qcloud.com

注意事项:

  • 刷新纪录保存 30 天
  • 支持精确到秒的时间区间查询
  • 支持根据提交时反馈的任务 taskId 进行查询
  • 支持根据域名查询刷新记录
  • 支持根据 url 查询刷新记录
  • 调用频次限制为 1000次/分钟
  • 接口已支持子账号调用,权限配置可参考权限配置示例

查看调用示例

入参说明

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 GetCdnRefreshLog。

参数名称 是否必选 类型 描述
startDate String 查询开始时间,如 2017-11-29 00:00:00
endDate String 查询结束时间,如 2017-11-29 00:05:00
taskId String 根据提交刷新URL任务返回的 task_id 查询
host String 需要查询的域名
url String 需要查询的URL(可为空)

详细说明

  • startDate&endDate 与 taskId 必须选择一种模式进行查询;
  • 若同时填充 startDate&endDate 和 taskId,若该taskId并非在此时间区间内提交,则会提示【日期不合法】。

出参说明

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。
详见错误码页面公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误信息,或业务侧错误码。
详见错误码页面业务错误码
data Array 返回结果数据

详细说明

data

参数名称 类型 描述
logs Array 日志详情
total Int 刷新次数

logs

参数名称 类型 描述
id Int 编号
app_id Int 用户APP ID
project_id Int 项目ID
host String 域名
type Int 刷新类型
0:代表URL刷新
1:代表目录刷新
status Int 刷新结果
1:表示刷新成功
0:表示刷新中
若为负数,表示刷新失败
url_list Array 本次刷新时提交的URL列表
datetime String 提交时间

调用示例

示例参数

startDate: 2017-02-06 19:00:00
endDate:  2017-02-06 19:40:00

GET 请求

GET 请求需要将所有参数都加在 URL 后:

https://cdn.api.qcloud.com/v2/index.php?
Action=GetCdnRefreshLog
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462422547
&Nonce=12345678
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX
&startDate=2017-02-06+19%3A00%3A00
&endDate=2017-02-06+19%3A40%3A00

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' => '2017-02-06 19:00:00',
  "endDate" => '2017-02-06 19:40:00'
)

结果示例

{
    "retcode": 0,
    "errmsg": "ok",
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "logs": [
            {
                "id": 6182538,
                "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": "2017-02-06 19:39:59"
            }
        "total": 1
    }
}