接口描述
本接口用于查询域名日志下载链接。
域名:dsa.api.qcloud.com
接口名:GetDsaHostLogs
注意:
- 该接口调用频次上限为 100 次/分钟,请勿高频调用。
- 该接口最多支持同时查询 10 个域名的日志下载链接。
- 默认情况下日志按照小时粒度打包并生成下载链接。
- 日志下载链接有效期为 24 小时,过期后需重新查询下载链接。
- 若查询时间段内,某一个小时未产生访问日志,则不会生成下载链接。
- 默认按天粒度查询下载日志,最多可获取最近 40 天的访问日志。
- 日志采集需要一定时间,无法实时采集全平台访问日志,稳定时间约 2 小时左右。
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面,此接口的 Action 字段为 GetDsaHostLogs
。
参数 | 必选 | 类型 | 取值示例 | 描述 |
---|---|---|---|---|
hosts | 是 | String | ["dsatest.qcloud.com"] | 域名列表,按 JSON 格式提交 详情请参见 代码示例 |
startDate | 否 | String | 2018-04-19 | 开始时间 格式:YY-MM-DD |
endDate | 否 | String | 2018-04-19 | 结束时间 格式:YY-MM-DD |
说明:
- 开始时间或结束时间为空时,默认返回当天日志下载链接。
- 当同时查询多个域名时,为了防止出现 URL 长度越界问题,建议尽量采用 POST 方式提交请求。
响应参数
参数 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码 0:表示成功 其他值:表示失败 详见请参见 错误码说明 页面的公共错误码 |
message | String | 模块错误信息描述,与接口相关 |
codeDesc | String | 英文错误信息,或业务侧错误码 |
data | Object | 日志下载链接数据,分域名展示,详细请参见 data 字段说明 |
data 字段说明
参数 | 类型 | 描述 |
---|---|---|
查询域名名称 | Array | 域名详细日志下载链接,详细请参见 域名详细日志下载链接字段说明 |
说明:当查询多个域名时,每个域名的日志下载链接单独一个数组展示,数组名称为域名名称。
如同时查询 a.dsa.qcloud.com 和 b.dsa.qcloud.com 这两个域名的日志下载链接,则返回的 data 中,分别有数组名称为 "a.dsa.qcloud.com" 和 "b.dsa.qcloud.com" 的日志链接数组。
域名详细日志下载链接字段说明
参数 | 类型 | 描述 |
---|---|---|
datetime | String | 日志时间段 例如:2018-04-19 12:00:00 |
url | String | 对应时间段的日志下载 URL |
代码示例
配置需求示例
查询 a.dsa.qcloud.com 和 b.dsa.qcloud.com 这两个域名 2018-04-18 的日志下载链接。
GET 请求
为了防止查询参数过长,导致 URL 越界,该接口默认采用 POST 方式提交查询请求。
POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GetDsaHostLogs',
'SecretId' => 'SecretId',
'Timestamp' => 1507805426982,
'Nonce' => 123456789,
'Signature' => 'Signature',
'hosts' => '["a.dsa.qcloud.com","b.dsa.qcloud.com"]',
'startDate' => '2018-04-18',
'endDate' => '2018-04-18'
)
返回结果示例
查询成功
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"a.dsa.qcloud.com": [
{
"datetime": "2018-04-18 00:00:00",
"url": "http://dsa-log-download.cdn.qcloud.com/20180418/00/20180418-a.dsa.qcloud.com?st=XBkcH5nGvXSCKqZcdNLORg&e=1508669326"
},
......
{
"datetime": "2018-04-18 23:00:00",
"url": "http://dsa-log-download.cdn.qcloud.com/20180418/23/20180418-a.dsa.qcloud.com?st=CtkcH5VGvXDCKqZcdgLORE&e=1108623346"
}
],
"b.dsa.qcloud.com":[
{
"datetime": "2018-04-18 00:00:00",
"url": "http://dsa-log-download.cdn.qcloud.com/20180418/00/20180418-b.dsa.qcloud.com?st=XBkcH5nGvXSCKqZcdNLORg&e=1508069326"
},
......
{
"datetime": "2018-04-18 23:00:00",
"url": "http://dsa-log-download.cdn.qcloud.com/20180418/23/20180418-b.dsa.qcloud.com?st=CtkcH5VGvXDCKqZcdgLORE&e=3108623346"
}
]
}
}
查询失败
{
"code": 4100,
"message": "鉴权失败,请参考文档中鉴权部分。",
"codeDesc": "AuthFailure"
}