获取应用状态监控 - ShowStatusApp
功能介绍
CPCS服务创建的应用状态监控
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cpcs:system:getStatus
Read
-
-
-
-
URI
GET /v1/{project_id}/dew/cpcs/app/status
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cluster_id |
否 |
String |
集群ID，默认空字符串，默认查询所有集群。 |
|
app_id |
否 |
String |
应用ID，默认空字符串，默认查询所有应用。 |
|
instance_id |
否 |
String |
集群ID，默认空字符串，默认查询所有集群。 |
|
from |
否 |
Long |
查询范围起始时间，毫秒时间戳，默认为0，默认查询三天前。 |
|
to |
否 |
Long |
查询范围终止时间，毫秒时间戳，默认为0，默认查询到当前时间。 |
|
period |
否 |
Integer |
数据统计周期，默认0，默认为5分钟。 |
|
filter |
否 |
String |
统计类型，默认min，默认用统计周期中数据的最小值。 |
|
server_type |
否 |
String |
服务类型，默认空字符串，默认查询所有服务类型。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
iam鉴权token |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metric_name |
String |
资源名称 |
|
app_list |
Array of ShowStatusAppItem objects |
应用列表 |
|
total_access_count |
Long |
总访问次数 |
|
success_access_count |
Long |
成功访问次数 |
请求示例
-
应用健康状态：不传appId 返回全量的 app信息
/v1/{project_id}/dew/cpcs/app/status?appId= -
应用健康状态：传appId 返回指定的app信息
/v1/{project_id}/dew/cpcs/app/status?appId=7bc173a0-1ab8-45ec-8dc7-3b84ec59e9d3
响应示例
状态码：200
正常返回
{
"metric_name" : "应用健康状态",
"app_list" : [ {
"success_rate" : 0,
"fail_rate" : 0,
"success_count" : 0,
"total_count" : 0,
"average_value" : 0,
"total_value" : 0,
"app_id" : "609e2dca2a184dfda1e733f3749963f5",
"app_name" : "12",
"status" : null
} ],
"total_access_count" : 0,
"success_access_count" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回 |
错误码
请参见错误码。
