密码资源指标监控 - ShowVmMonitor
功能介绍
获取密码服务实例与虚拟密码机实例的指标(cpu使用率,内存使用率等指标)。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cpcs::getVMInfo
Read
-
-
cpcs:system:getVMInfo
-
URI
GET /v1/{project_id}/dew/cpcs/vm-monitor
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 是 | String | 参数解释: 所属空间,分别从不同的来源获取监控数据,有:ECS,DHSM 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| metric_name | 是 | String | 参数解释: 指标名称,有:mem_util,cpu_uttl,network_outgoing_bytes_rate_inband 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| instance_id | 否 | String | 参数解释: 实例id,默认空字符串,默认查询所有实例。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| vsm_id | 否 | String | 参数解释: 虚拟机id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| from | 否 | Long | 参数解释: 查询时间范围的起始时间,毫秒时间戳,默认0,默认查询从三天前。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to | 否 | Long | 参数解释: 查询时间范围的终止时间,毫秒时间戳,默认0,默认查询到当前时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| period | 否 | Integer | 参数解释: 统计数据周期,默认0,默认周期为5分钟 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| filter | 否 | String | 参数解释: 统计值类型,默认min,默认查询最小值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| datapoints | Array of Datapoint objects | 参数解释: 指标的时间序列 取值范围: 不涉及 |
| metric_name | String | 参数解释: 指标名称,比如:cpu_util 取值范围: 不涉及 |
| max | Double | 参数解释: 最大值,未计算默认为0 取值范围: 不涉及 |
| average | Double | 参数解释: 平均值,未计算默认为0 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| max | Double | 参数解释: 最大值,未计算默认为0 取值范围: 不涉及 |
| min | Double | 参数解释: 最小值,未计算默认为0 取值范围: 不涉及 |
| average | Double | 参数解释: 平均值,未计算默认为0 取值范围: 不涉及 |
| sum | Double | 参数解释: 综合,未计算默认为0 取值范围: 不涉及 |
| variance | Double | 参数解释: 方差,未计算默认为0 取值范围: 不涉及 |
| timestamp | Long | 参数解释: 毫秒时间戳 取值范围: 不涉及 |
| unit | String | 参数解释: 数据单位,比如%,个 取值范围: 不涉及 |
请求示例
-
GET https://cpcs.com/v1/{project_id}/dew/cpcs/vm-monitor?namespace=ECS&from=1736933523900&to=1737019923900&period=3600&metric_name="cpu_util"&instance_id=343486d6-ffae-4ac8-a51c-3d49a9d485af -
GET https://cpcs.com/v1/{project_id}/dew/cpcs/vm-monitor?namespace=ECS&from=1736933523900&to=1737019923900&period=3600&metric_name="cpu_util"&instance_id=
响应示例
状态码:200
正常返回
{
"average" : 0,
"max" : 0,
"datapoints" : [ {
"max" : 0,
"min" : 80,
"average" : 0,
"sum" : 0,
"variance" : 0,
"timestamp" : 1736933523900,
"unit" : "%"
}, {
"max" : 0,
"min" : 0,
"average" : 0,
"sum" : 0,
"variance" : 0,
"timestamp" : 1736937123900,
"unit" : "%"
}, {
"max" : 0,
"min" : 0,
"average" : 0,
"sum" : 0,
"variance" : 0,
"timestamp" : 1737019923900,
"unit" : "%"
} ],
"metric_name" : "cpu_util"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 正常返回 |
错误码
请参见错误码。