1. 接口描述
本接口(GetCdnOverseaStatusCode)用于查询指定域名、指定日期的状态码统计信息。
每五分钟一个统计点,一天共有288个统计点。
指定日期可选区间为30天内。
一次可查询一个域名,域名需要已经开通境外 CDN。
接口请求域名:<font style="color:red">cdn.api.qcloud.com</font>
2. 输入参数
参数名称 | 是否必选 | 类型 | 描述 |
date | 是 | String | 指定查询日期,格式为:2016-09-22 |
host | 是 | String | 指定要查询的域名 |
Note:
date:查询日期,暂时仅支持30天内数据查询,格式需要为 xxxx-xx-xx。
3. 输出参数
参数名称 | 类型 | 描述 |
code | Int | |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误信息,或业务侧错误码。 |
data | Object | 返回结果数据,详细说明如下 |
data 字段说明
参数名称 | 类型 | 描述 |
period | Int | 统计数据时间区间,默认为5分钟 |
app_id | String | |
host | String | 指定查询的域名 |
start_datetime | String | 查询起始时间点,若填入日期为2016-09-22,则为2016-09-22 00:00:00 |
end_datetime | String | 查询结束时间点,若填入日期为2016-09-22,则为2016-09-22 23:55:00 |
time_data | Object | 状态码明细数据,详细说明如下 |
code_data | Array | 各个状态码的总数,详细说明如下 |
time_data 字段说明
参数名称 | 类型 | 描述 |
2XX | Array | HTTP 状态码为 2XX 的统计量 |
3XX | Array | HTTP 状态码为 3XX 的统计量 |
4XX | Array | HTTP 状态码为 4XX 的统计量 |
5XX | Array | HTTP 状态码为 5XX 的统计量 |
Note:
每一类状态码统计数据为 Int 数组,从指定查询日期0点开始,每5分钟一个数据。
00:00:00点的统计量代表了00:00:00 - 00:04:59期间的统计量。
code_data 字段说明
参数名称 | 类型 | 描述 |
name | Int | 状态码编号 |
count | Int | 状态码出现总次数 |
ratio | Float | 状态码次数占总数的比例 |
4. 示例
4.1 输入示例
date: 2016-09-22 host: www.test.com
4.2 GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?Action=GetCdnOverseaStatusCode&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Timestamp=1462422547&Nonce=12345678&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX&date=2016-09-22&host=www.test.com
4.3 POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array ('Action' => 'GetCdnOverseaStatusCode','SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX','Timestamp' => 1462782282,'Nonce' => 123456789,'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX','date' => '2016-09-22',"host" => 'www.test.com')
4.4 返回结果示例
{"code": 0,"message": "","codeDesc": "Success","data": {"start_datetime": "2016-09-22 00:00:00","end_datetime": "2016-09-22 23:55:00","period": 5,"time_data": {"2xx": [5,12,...],"3xx": [],"4xx": [1,0,...],"5xx": []},"code_data": [{"name": 200,"count": 606,"ratio": 0.52604166666667},{"name": 206,"count": 0,"ratio": 0},{"name": 302,"count": 0,"ratio": 0},{"name": 304,"count": 0,"ratio": 0},{"name": 401,"count": 0,"ratio": 0},{"name": 403,"count": 0,"ratio": 0},{"name": 404,"count": 546,"ratio": 0.47395833333333},{"name": 405,"count": 0,"ratio": 0},{"name": 416,"count": 0,"ratio": 0},{"name": 500,"count": 0,"ratio": 0},{"name": 502,"count": 0,"ratio": 0}],"app_id": 12345678,"host": "www.test.com"}}