链接复制成功!
查询云应用接入统计数据
功能介绍
查询云应用接入统计数据,一次最多查询30天,支持最近30天的数据查询。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/statistics/metrics/app-user-access
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
是 |
String |
查询起始时间,格式为:UTC格式,例如"2022-05-11T11:45:42Z。" |
end_time |
是 |
String |
查询截至时间,格式为:UTC格式,例如"2022-05-11T11:45:42Z。" |
username |
否 |
String |
用户名(模糊匹配)。 |
sort_field |
否 |
String |
按照指标进行排序
|
sort_type |
否 |
String |
按照指标进行排序的方向;需配合sort_field一起使用
|
offset |
否 |
Integer |
查询的偏移量,默认值0。 |
limit |
否 |
Integer |
limit范围[1-100],默认值10。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
总数。 |
items |
Array of AppUserAccessData objects |
用户统计指标。 |
参数 |
参数类型 |
描述 |
---|---|---|
username |
String |
用户名称。 |
access_failed_count |
Integer |
接入失败数。 |
last_access_failed_time |
String |
最近一次接入失败时间,UTC时间,格式为:2022-05-11T11:45:42Z。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
状态码:200
响应成功。
{
"count" : 0,
"items" : [ {
"username" : "xxxx",
"access_failed_count" : 3,
"last_access_failed_time" : "2022-05-11T11:45:42Z",
"error_code" : "WKS.xxx",
"error_msg" : "login failed."
} ]
}
状态码
状态码 |
描述 |
---|---|
200 |
响应成功。 |
400 |
客户端请求有误。 |
401 |
鉴权失败。 |
500 |
内部错误。 |
错误码
请参见错误码。