预热记录查询

最近更新时间:2020-05-29 11:30:55

我的收藏
URL 预热接口目前已开放内测,欢迎提交 工单申请 使用接口。

接口描述

GetPushLogs 查询提交的预拉热任务执行状态。 请求域名:cdn.api.qcloud.com
Note:
预热记录保存30天。
支持指定时间区间查询。
支持根据提交时反馈的任务 taskId 进行查询。
支持指定多个域名查询。
支持指定任务状态、指定关键字查询。
支持分页查询。
调用频次限制为300次/分钟。
接口已支持子账号调用,权限配置可参考权限 配置示例
更多信息,请参见 示例代码

入参说明

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 GetPushLogs。
参数名称
是否必选
类型
描述
startDate
String
指定查询起始时间,如:2017-11-29 00:00:00。
endDate
String
指定查询结束时间,如:2017-11-29 20:00:00。
taskId
Int
预热任务提交时返回的 ID。
hosts.n
String
指定域名查询。
status.n
String
预热任务状态:<br/>"init":表示状态为排队中,尚未开始。<br/>"process":表示预热任务执行中。<br/>"done":表示预热任务已经完成。<br/>可指定上述状态中一个或多个进行查询。
keyword
String
关键字查询。
offset
Int
查询偏移量,用于分页。
limit
Int
返回记录数目,用于分页。

详细说明

使用 CdnPusherV2 提交的预热任务,需要填写 startDate、endDate、taskId 进行组合查询,若该 taskId 并非在此时间区间内提交,则会提示【日期不合法】。
使用 CdnUrlPusher 提交的预热任务,填写 taskId 即可进行查询。

出参说明

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

详细说明

data 说明

参数名称
类型
描述
logs
Object
预热任务详情,详情请参见下文 logs 说明
total
Int
查询到的预热 URL 总次数。

logs 说明

参数名称
类型
描述
log_id
Int
该条操作记录对应的 ID。
task_id
Int
预热任务提交时返回的 ID。
host
String
域名,预热 URL 对应的域名。
datetime
String
预热任务提交的时间。
status
String
预热任务当前状态:<br/>"init":初始化中。<br/>"queue":预热队列等待中。<br/>"process":预热中。<br/>"done":预热任务已完成。<br/>"fail":预热任务执行失败。
url
String
预热的 URL。

调用示例(CdnPusherV2 任务查询)

示例参数

startDate:2018-03-27 00:00:00
endDate: 2018-03-27 21:00:00
taskId:41773

GET 请求

GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?
Action=GetPushLogs
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1522135761
&Nonce=12345678
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX
&startDate=2018-03-27+00%3A00%3A00
&endDate=2018-03-27+21%3A00%3A00
&taskId=41773

POST 请求

POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GetPushLogs',
'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
'Timestamp' => 1522135761,
'Nonce' => 123456789,
'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
'startDate' => '2018-03-27 00:00:00',
'endDate' => '2018-03-27 21:00:00'
'taskId' => 41773
)

结果示例

{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"logs": [
{
"log_id": 45651,
"task_id": 41773,
"host": "www.test.com",
"datetime": "2018-03-27 02:40:13",
"status": "process",
"url": "http://www.test.com/1.jpg",
"result": "",
"progress": 100
}
],
"total": 1
}
}

调用示例(CdnUrlPusher 任务查询)

示例参数

taskId:1522134939950455

GET 请求

GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?
Action=GetPushLogs
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1522135761
&Nonce=12345678
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX
&taskId=1522134939950455

POST 请求

POST请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GetPushLogs',
'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
'Timestamp' => 1522135761,
'Nonce' => 123456789,
'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
'taskId' => '1522134939950455'
)

结果示例

{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"logs": [
{
"log_id": 45820,
"task_id": 1522134939950455,
"host": "www.test.com",
"datetime": "2018-03-27 02:40:13",
"status": "process",
"url": "http://www.test.com/1.jpg",
"result": "",
"progress": 100
}
],
"total": 1
}
}