# 获取集群监控信息 - ShowStatusCluster
#### 功能介绍
CPCS服务创建的集群的状态监控
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                    | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                           | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | cpcs::getStatusCluster | Read | -           | -   | cpcs:system:getStatusCluster | -      |
     
  
 
#### URI
GET /v1/{project_id}/dew/cpcs/cluster/status
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 字符长度为32 **默认取值：** 不涉及 |
   
表2Query参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| cluster_id  | 否    | String  | **参数解释：** 集群ID，默认空字符串，默认查询所有集群。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串       |
| app_id      | 否    | String  | **参数解释：** 应用ID，默认空字符串，默认查询所有应用。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串       |
| instance_id | 否    | String  | **参数解释：** 实例ID，默认空字符串，默认查询所有实例。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串       |
| from        | 否    | Long    | **参数解释：** 查询范围起始时间，毫秒时间戳，默认为0，默认查询三天前。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0   |
| to          | 否    | Long    | **参数解释：** 查询范围终止时间，毫秒时间戳，默认为0，默认查询到当前时间。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0 |
| period      | 否    | Integer | **参数解释：** 数据统计周期，默认为5分钟。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 1                 |
| filter      | 否    | String  | **参数解释：** 统计类型，默认min，默认用统计周期中数据的最小值。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** min   |
| server_type | 否    | String  | **参数解释：** 服务类型，默认空字符串，默认查询所有服务类型。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串     |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数           | 参数类型                                                                                         | 描述                                                                                                                                          |
|:---|:---|:---|
| metric_name  | String                                                                                       | **参数解释：** 资源名称 **取值范围：** 不涉及 |
| cluster_list | Array of [ShowStatusClusterItem] objects | **参数解释：** 集群列表 **取值范围：** 不涉及 |
   
 表5ShowStatusClusterItem 
| 参数            | 参数类型    | 描述                                                                                                                                                                         |
|:---|:---|:---|
| success_rate  | Double  | **参数解释：** 成功率 **取值范围：** 0.0\~1.0                            |
| fail_rate     | Double  | **参数解释：** 失败率 **取值范围：** 0.0\~1.0                            |
| success_count | Long    | **参数解释：** 成功次数 **取值范围：** 不涉及                                |
| total_count   | Long    | **参数解释：** 总次数 **取值范围：** 不涉及                                 |
| average_value | Double  | **参数解释：** 监控指标的平均值 **取值范围：** 不涉及                            |
| total_value   | Double  | **参数解释：** 监控指标的总数 **取值范围：** 不涉及                             |
| limit         | Boolean | **参数解释：** 指标是否超出限制，true：指标已超出限制，false：指标未超出限制 **取值范围：** 不涉及 |
| 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"
  } ]
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 正常返回 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。