API统计信息查询-最近一段时间
功能介绍
根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。
![](https://support.huaweicloud.com/intl/zh-cn/my-kualalumpur-1-api-apig/public_sys-resources/note_3.0-zh-cn.png)
为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/.bash_history”、“/var/log/messages”(如有)。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/api/latest
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID,在API网关控制台的“实例信息”中获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
api_id |
是 |
String |
API的编号 |
duration |
是 |
String |
最近统计时长,单位必须为h和m,比如1h和1m,分别代表最近1小时和最近1分钟 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
响应码 |
msg |
String |
返回消息 |
start_time |
Long |
开始时间的UTC的时间戳 |
end_time |
Long |
截止时间的UTC的时间戳 |
list |
Array of StatisticsAPI objects |
统计指标的数据结构结构体 |
参数 |
参数类型 |
描述 |
---|---|---|
max_latency |
Integer |
最大延时 单位:ms |
avg_latency |
Float |
平均延时 单位:ms |
req_count |
Integer |
请求总次数 |
req_count2xx |
Integer |
2xx响应码总次数 |
req_count4xx |
Integer |
4xx响应码总次数 |
req_count5xx |
Integer |
5xx响应码总次数 |
req_count_error |
Integer |
错误次数 |
max_inner_latency |
Integer |
最大网关内部延时 单位:ms |
avg_inner_latency |
Float |
平均网关内部延时 单位:ms |
max_backend_latency |
Integer |
最大后端延时 |
avg_backend_latency |
Float |
平均后端延时 |
output_throughput |
Long |
下行吞吐量(byte) |
input_throughput |
Long |
上行吞吐量(byte) |
current_minute |
Long |
API访问的UTC时间戳 |
cycle |
String |
统计周期 枚举值:
|
api_id |
String |
API编号 |
group_id |
String |
API分组编号 |
provider |
String |
API拥有者 |
req_time |
String |
API请求时间 |
register_time |
String |
记录时间 |
status |
Integer |
状态 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
OK
{ "code" : "APIG.0000", "start_time" : 1595573280, "end_time" : 1595576820, "list" : [ { "api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9", "avg_backend_latency" : 2.71, "avg_inner_latency" : 1.57, "avg_latency" : 4.14, "current_minute" : 1595576640, "cycle" : "MINUTE", "group_id" : "d0fc4e40b7d1492cba802f667c7c7226", "input_throughput" : 1071, "max_backend_latency" : 6, "max_inner_latency" : 8, "max_latency" : 14, "output_throughput" : 3790, "provider" : "73d69ae0cfcf460190522d06b60f05ad", "register_time" : "2020-07-24 15:44:56", "req_count" : 7, "req_count2xx" : 0, "req_count4xx" : 6, "req_count5xx" : 1, "req_count_error" : 7, "req_time" : "2020-07-24 15:44:00", "status" : 1 } ] }
状态码: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation" }
状态码: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
状态码: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
状态码: 404
Not Found
{ "error_code" : "APIG.3002", "error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" }
状态码: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。