获取实例监控信息 - ShowStatusInstance
功能介绍
CPCS服务创建的密码服务实例的状态监控
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cpcs::getStatusInstance
Read
-
-
cpcs:system:getStatusInstance
-
URI
GET /v1/{project_id}/dew/cpcs/instance/status
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cpu_utils | Array of ShowStatusInstanceItem objects | 参数解释: CPU使用率 取值范围: 不涉及 |
| mem_utils | Array of ShowStatusInstanceItem objects | 参数解释: 内存使用率 取值范围: 不涉及 |
| disk_utils | Array of ShowStatusInstanceItem objects | 参数解释: 磁盘使用率 取值范围: 不涉及 |
| cpu_util_instance_names | Array of strings | 参数解释: CPU使用率对应实例名称 取值范围: 不涉及 |
| mem_util_instance_names | Array of strings | 参数解释: 内存使用率对应实例名称 取值范围: 不涉及 |
| disk_util_instance_names | Array of strings | 参数解释: 磁盘使用率对应实例名称 取值范围: 不涉及 |
| cpu_util_averages | Array of doubles | 参数解释: CPU使用率平均值 取值范围: 不涉及 |
| mem_util_averages | Array of doubles | 参数解释: 内存使用率平均值 取值范围: 不涉及 |
| disk_util_averages | Array of doubles | 参数解释: 磁盘使用率平均值 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_list | Array of instance_list objects | 参数解释: 实例列表 取值范围: 不涉及 |
| timestamp | Integer | 参数解释: 采集时间,UNIX时间戳,单位毫秒 取值范围: 不涉及 |
请求示例
-
GET https://cpcs.com/v1/{project_id}/dew/cpcs/instance/status?from=1736933523900&to=1737019923900&period=3600&metric_name="cpu_util"&instance_id= -
GET https://cpcs.com/v1/{project_id}/dew/cpcs/instance/status?from=1736933523900&to=1737019923900&period=3600&metric_name="cpu_util"&instance_id=
响应示例
状态码:200
正常返回
{
"disk_util_instance_names" : [ "dsfdsaaaaaa-0", "test_crypto-0" ],
"mem_util_averages" : [ 31.987796610169507, 0 ],
"mem_util_instance_names" : [ "dsfdsaaaaaa-0", "test_crypto-0" ],
"cpu_util_averages" : [ 4.03, 0 ],
"mem_utils" : [ {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 30.2
} ],
"timestamp" : 1757416860002
}, {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 30.3
} ],
"timestamp" : 1757416920002
} ],
"cpu_util_instance_names" : [ "dsfdsaaaaaa-0", "test_crypto-0" ],
"disk_util_averages" : [ 7.627288135593223, 0 ],
"cpu_utils" : [ {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 3.51
} ],
"timestamp" : 1757416860002
}, {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 3.26
} ],
"timestamp" : 1757416920002
} ],
"disk_utils" : [ {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 7.62
} ],
"timestamp" : 1757416860002
}, {
"instance_list" : [ {
"instance_name" : "test_crypto-0",
"value" : 0
}, {
"instance_name" : "dsfdsaaaaaa-0",
"value" : 7.62
} ],
"timestamp" : 1757416920002
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 正常返回 |
错误码
请参见错误码。