调用本接口查询加速域名HTTP状态码的总数和占比数据。本接口支持查询的数据时间粒度最小为1分钟,数据延迟最少为5分钟,最长可查询最近186天的数据。
接口说明
目前该接口服务地址仅支持:华东 2(上海)。
支持批量查询,一次最多查询 100 个域名数据。
如果您不指定
StartTime和EndTime,该接口默认返回过去 1 小时的数据;指定StartTime和EndTime,该接口返回指定时间段的数据。
返回数据时间粒度
根据您指定StartTime和EndTime时间跨度,会返回不同的数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:
| 时间粒度 | 单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |
| 1 分钟 | 单次查询的时间跨度 ≤ 1 小时 | 7 天 | 5 分钟 |
| 5 分钟 | 1 小时 < 单次查询的时间跨度 < 3 天 | 93 天 | 15 分钟 |
| 1 小时 | 3 天 ≤ 单次查询的时间跨度 <31 天 | 186 天 | 一般延迟 3-4 小时 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:DescribeVodDomainRealTimeHttpCodeData |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DomainName |
string |
是 |
要查询的加速域名。
|
example.com |
| StartTime |
string |
否 |
获取数据的起始时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 |
2019-11-30T05:39:00Z |
| EndTime |
string |
否 |
获取数据的结束时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。 |
2019-11-30T05:40:00Z |
| IspNameEn |
string |
否 |
运营商英文名。不传该参数默认查询所有运营商。 |
unicom |
| LocationNameEn |
string |
否 |
地域英文名。不传该参数默认查询所有地域。 |
shanghai |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| EndTime |
string |
数据的结束时间点。 |
2019-11-30T05:40:00Z |
| StartTime |
string |
数据的起始时间点。 |
2019-11-30T05:39:00Z |
| RequestId |
string |
请求 ID。 |
BC858082-736F-4A25-867B-E5B67C85ACF7 |
| DomainName |
string |
加速域名。 |
example.com |
| DataInterval |
string |
每条数据的时间间隔,单位:秒。 根据单次查询的时间跨度不同,该参数固定返回 60(1 分钟)、300(5 分钟)或 3600(1 小时),具体请参见接口说明中的返回数据时间粒度。 |
60 |
| RealTimeHttpCodeData |
object |
||
| UsageData |
array<object> |
每个时间间隔的 HTTP 状态码占比数据。 |
|
|
array<object> |
|||
| TimeStamp |
string |
数据时间戳。日期格式按照 ISO8601 表示法,并使用 UTC 时间。 |
2019-11-30T05:39:00Z |
| Value |
object |
||
| RealTimeCodeProportionData |
array<object> |
各状态码占比使用数据列表。 |
|
|
object |
|||
| Code |
string |
HTTP 状态码。 |
500 |
| Proportion |
string |
该 HTTP 状态码的占比(百分比数据)。 |
28.4496124031008 |
| Count |
string |
该 HTTP 状态码的总数。 |
100 |
示例
正常返回示例
JSON格式
{
"EndTime": "2019-11-30T05:40:00Z",
"StartTime": "2019-11-30T05:39:00Z",
"RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
"DomainName": "example.com",
"DataInterval": "60",
"RealTimeHttpCodeData": {
"UsageData": [
{
"TimeStamp": "2019-11-30T05:39:00Z",
"Value": {
"RealTimeCodeProportionData": [
{
"Code": "500",
"Proportion": "28.4496124031008",
"Count": "100"
}
]
}
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 必须同时指定开始时间和结束时间 |
| 400 | InvalidStartTime.Malformed | The specified StartTime is invalid. | |
| 400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 结束时间早于开始时间 |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。