获取集群监控信息 - ShowStatusCluster

功能介绍

CPCS服务创建的集群的状态监控

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cpcs::getStatusCluster
Read
-
-
cpcs:system:getStatusCluster
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
cpcs::getStatusCluster	Read	-	-	cpcs:system:getStatusCluster	-

URI

GET /v1/{project_id}/dew/cpcs/cluster/status

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id

表2 Query参数
参数	是否必选	参数类型	描述
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	服务类型，默认空字符串，默认查询所有服务类型。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	iam鉴权token

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
metric_name	String	资源名称
cluster_list	Array of ShowStatusClusterItem objects	集群列表

表5 ShowStatusClusterItem
参数	参数类型	描述
success_rate	Double	成功率
fail_rate	Double	失败率
success_count	Long	成功次数
total_count	Long	总次数
average_value	Double	平均值
total_value	Double	总数
limit	Boolean	指标是否超出限制
cluster_id	String	集群ID
cluster_name	String	集群名称

请求示例

集群的健康状况：获取一个集群的健康状况

GET https://cpcs.com/v1/{project_id}/dew/cpcs/cluster/status?clusterId=a3421d6e-616c-4f31-9f23-0f6e0b6634fb

集群的健康状况：获取所有集群的健康状况

GET https://cpcs.com/v1/{project_id}/dew/cpcs/cluster/status

响应示例

状态码：200

正常返回

{
  "metric_name" : "集群健康状态",
  "cluster_list" : [ {
    "limit" : false,
    "success_rate" : 0,
    "fail_rate" : 1,
    "success_count" : 0,
    "total_count" : 1,
    "average_value" : 0,
    "total_value" : 0,
    "cluster_id" : "1f5dc381828240f088c20f197973416e",
    "cluster_name" : "test_xx"
  }, {
    "limit" : false,
    "success_rate" : 0,
    "fail_rate" : 0,
    "success_count" : 0,
    "total_count" : 0,
    "average_value" : 0,
    "total_value" : 0,
    "cluster_id" : "227c92f3b5e849e3bbff50f1b57c2143",
    "cluster_name" : "fdsfs"
  } ]
}