分组统计信息查询-最近一小时内 - ListLatelyGroupStatisticsV2
功能介绍
根据API分组的编号查询该分组下所有API被调用的总次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apig:instance:listApiGroupMonitoring
List
instance *
g:ResourceTag/<tag-key>
- apig:groups:get
apig:instance:get
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/group/latest
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID,在API网关控制台的“实例信息”中获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_id |
是 |
String |
API分组的编号 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 StatisticsGroup 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 |
错误次数 |
|
output_throughput |
Long |
下行吞吐量(byte) |
|
input_throughput |
Long |
上行吞吐量(byte) |
|
current_minute |
Long |
API访问的UTC时间戳 |
|
group_id |
String |
API分组编号 |
|
provider |
String |
API拥有者 |
|
req_time |
String |
API请求时间 |
|
register_time |
String |
记录时间 |
状态码: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" : 1595574540,
"end_time" : 1595578080,
"list" : [ {
"avg_latency" : 4.14,
"current_minute" : 1595576640,
"group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
"input_throughput" : 1071,
"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"
}, {
"avg_latency" : 3.67,
"current_minute" : 1595577900,
"group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
"input_throughput" : 915,
"max_latency" : 6,
"output_throughput" : 2763,
"provider" : "73d69ae0cfcf460190522d06b60f05ad",
"register_time" : "2020-07-24 16:05:12",
"req_count" : 6,
"req_count2xx" : 3,
"req_count4xx" : 0,
"req_count5xx" : 3,
"req_count_error" : 3,
"req_time" : "2020-07-24 16:05:00"
} ]
}
状态码:400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:group_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.3001",
"error_msg" : "API group d0fc4e40b7d1492cba802f667c7c7226 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 |
错误码
请参见错误码。