调用DescribeDomainReqHitRateData查询请求命中率(命中请求百分比)。
使用说明
- 单用户调用频率:100次/秒。
- 如果您不指定StartTime和EndTime,该接口返回过去24小时的数据;指定StartTime和EndTime,该接口返回指定时间段的数据。
根据单次查询的最大时间跨度不同,请求参数Interval支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:
时间粒度 |
单次查询的最大时间跨度 |
可查询历史数据时间范围 |
数据延迟 |
---|---|---|---|
5分钟 |
3天 |
93天 |
15分钟 |
1小时 |
31天 |
186天 |
4小时 |
1天 |
366天 |
366天 |
次日凌晨4点 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomainReqHitRateData |
系统规定参数。取值:DescribeDomainReqHitRateData。 |
DomainName | String | 否 | example.com |
加速域名,多个域名用半角逗号(,)分隔,一次最多支持500个域名查询。 默认查询所有加速域名。 |
StartTime | String | 否 | 2017-12-21T08:00:00Z |
获取数据起始时间点。 日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
EndTime | String | 否 | 2017-12-22T08:00:00Z |
获取数据结束时间点。 日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 结束时间需大于起始时间。
|
Interval | String | 否 | 300 |
指定查询数据的时间粒度,单位:秒。 根据单次查询的最大时间跨度不同,该参数支持300(5分钟)、3600(1小时)和86400(1天)取值,具体请参见使用说明中支持查询的时间粒度。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
EndTime | String | 2017-12-22T08:00:00Z |
结束时间。 |
StartTime | String | 2017-12-21T08:00:00Z |
开始时间。 |
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
请求ID。 |
DomainName | String | example.com |
加速域名信息。 |
DataInterval | String | 300 |
每条记录的时间间隔,单位:秒。 |
ReqHitRateInterval | Array of DataModule |
每个时间间隔的请求命中百分占比。 |
|
DataModule | |||
Value | String | 100.0 |
命中率信息。 |
TimeStamp | String | 2017-12-22T08:00:00:00Z |
时间片起始时刻。 |
HttpsValue | String | 50.0 |
HTTPS请求命中率。 |
示例
请求示例
http(s)://cdn.aliyuncs.com/?Action=DescribeDomainReqHitRateData
&DomainName=example.com
&StartTime=2017-12-21T08:00:00Z
&EndTime=2017-12-22T08:00:00Z
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDomainReqHitRateDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<RequestId>5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD</RequestId>
<StartTime>2017-12-21T08:00:00Z</StartTime>
<EndTime>2017-12-22T08:00:00Z</EndTime>
<ReqHitRateInterval>
<DataModule>
<TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
<Value>100.0</Value>
<HttpsValue>50.0</HttpsValue>
</DataModule>
<DataModule>
<TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
<Value>100.0</Value>
<HttpsValue>50.0</HttpsValue>
</DataModule>
</ReqHitRateInterval>
</DescribeDomainReqHitRateDataResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DomainName" : "example.com",
"DataInterval" : "300",
"RequestId" : "5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD",
"StartTime" : "2017-12-21T08:00:00Z",
"EndTime" : "2017-12-22T08:00:00Z",
"ReqHitRateInterval" : {
"DataModule" : [ {
"TimeStamp" : "2015-12-10T21:00:00Z",
"Value" : "100.0",
"HttpsValue" : "50.0"
}, {
"TimeStamp" : "2015-12-10T20:35:00Z",
"Value" : "100.0",
"HttpsValue" : "50.0"
} ]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 起始时间格式错误。日期格式请参考所调用API的帮助文档说明。 |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间格式错误。日期格式请参考所调用API的帮助文档说明。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 开始时间设置错误,请检查更新后重试。 |
访问错误中心查看更多错误码。