1. 接口描述
本接口(GenerateLogList)用于查询指定时间区间内,指定域名日志的下载链接,一次仅可指定一个域名进行查询。
接口请求域名:cdn.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为GenerateLogList。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
hostId | 是 | Int | 域名对应 ID |
startDate | 否 | String | 查询起始日期 |
endDate | 否 | String | 查询结束日期 |
注意事项
- 可使用接口 根据域名查询域名信息 、查询域名信息 获取 host 对应的 ID;
- startDate 和 endDate 需要小于等于当前日期;
- 未填充startDate和endDate时,默认查询区间为当前时间前推30天,每小时提供一个日志下载链接,更多日志相关说明可查看日志下载 ;
- startDate为查询开始日期,endDate为查询结束日期,假设 startDate=20160813,endDate=20160815,实际查询的日期为8-13、8-14、8-15三天的日志下载链接,每天24个链接;
- 日志下载链接的有效期为24小时。
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面的公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误信息,或业务侧错误码。 |
data | Array | 结果数据,详细说明见下文 |
data字段说明
参数名称 | 类型 | 描述 |
---|---|---|
now | Int | 当前时间,Unix 时间戳 |
list | Array | 日志下载链接列表 |
list 字段说明
参数名称 | 类型 | 描述 |
---|---|---|
date | Int | 日志日期 |
type | Int | 是否有日志;1:有日志;0:无日志 |
name | String | 日志名称,格式为:日期小时-域名,如 2016050301-www.test.com |
link | String | 下载链接 |
4. 示例
4.1 输入示例
hostId: 1234
4.2 GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?
Action=GenerateLogList
&SecretId=XXXXXXXXXXXXXXXXX
&Timestamp=1462430812
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXX
&hostId=1234
4.3 POST 请求
POST请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GenerateLogList',
'SecretId' => 'XXXXXXXXXXXXXXXXXXX',
'Timestamp' => 1462865760,
'Nonce' => 1058191224,
'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXX',
'hostId' => '1234'
)
4.4 返回结果示例
{
"code":0,
"message":"",
"codeDesc": "Success",
"data":{
"now":1461064041,
"list":[
{
"date":2016-03-20,
"type":1,
"name":"2016032000-www.test.com",
"link":"http://log-download.cdn.qcloud.com/20160320/2016032000-www.test.com.gz?st=XXXXXXXXXXXXXXXXX&e=1461928041"
},
{
"date":2016-03-20,
"type":1,
"name":"2016032001-www.test.com",
"link":"http://log-download.cdn.qcloud.com/20160320/2016032001-www.test.com.gz?st=XXXXXXXXXXXXXXXXX&e=1461928042"
},
...
]
}
}