文档首页/数据库安全服务 DBSS/API参考/API说明/审计实例/获取实例监控数据 - ShowInstanceMonitorInfo
更新时间：2026-01-22 GMT+08:00
查看PDF
分享

获取实例监控数据 - ShowInstanceMonitorInfo

功能介绍

获取实例监控数据

URI

POST /v1/{project_id}/audit/{instance_id}/system/monitorinfo

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

time

是

Duration object

查询时间范围，time_range属性优先于start_time/end_time

表4 Duration

参数

是否必选

参数类型

描述

end_time

否

String

结束时间

start_time

否

String

开始时间

time_range

否

String

时间范围

  • HALF_HOUR：半小时

  • HOUR：1小时

  • THREE_HOUR：3小时

  • TWELVE_HOUR：12小时

  • DAY：1天

  • WEEK：1周

  • MONTH：1个月

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

disk_infos

DiskInfo object

磁盘使用情况

system_infos

Array of SystemInfo objects

系统信息

traffic_infos

Array of TrafficInfo objects

流量统计

表6 DiskInfo

参数

参数类型

描述

data_available

Double

数据盘可用量

data_total

Double

数据盘总容量

data_use_percent

Integer

数据盘使用百分比

id

String

记录ID

swap_available

Double

临时目录可用量

swap_total

Double

临时目录总容量

swap_use_percent

Integer

临时目录使用百分比

system_available

Double

系统盘可用量

system_total

Double

系统盘容量

system_use_percent

Integer

系统盘使用百分比

time

String

记录时间

表7 SystemInfo

参数

参数类型

描述

cpu_use

Double

CPU使用量

id

String

记录ID

mem_use

Double

内存使用量

time

String

记录时间

表8 TrafficInfo

参数

参数类型

描述

id

String

记录ID

rxmegabytes

Double

每秒钟接收字节数

time

String

记录时间

txmegabytes

Double

每秒钟发送字节数

状态码：400

表9 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表10 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表11 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表12 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表13 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表14 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表15 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表16 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v1/{project_id}/audit/{instance_id}/system/monitorinfo

{
  "time" : {
    "time_range" : "HOUR",
    "end_time" : "",
    "start_time" : ""
  }
}

响应示例

状态码：200

OK

{
  "system_infos" : [ {
    "id" : null,
    "time" : "2025-08-18 16:00:00-2025-08-18 16:37:17",
    "cpu_use" : 1,
    "mem_use" : 43.39
  }, {
    "id" : null,
    "time" : "2025-08-18 16:37:17-2025-08-18 17:14:34",
    "cpu_use" : 1,
    "mem_use" : 43.38
  } ],
  "traffic_infos" : [ {
    "id" : null,
    "time" : "2025-08-18 16:00:00-2025-08-18 16:37:17",
    "txmegabytes" : 0.0125,
    "rxmegabytes" : 0.0125
  } ],
  "disk_infos" : {
    "id" : null,
    "time" : "2025-08-19 14:50:00",
    "system_available" : 13.47,
    "system_total" : 18.59,
    "system_use_percent" : 28,
    "data_available" : 955.56,
    "data_total" : 1006.85,
    "data_use_percent" : 5,
    "swap_available" : 0,
    "swap_total" : 0,
    "swap_use_percent" : 0
  }
}

状态码

状态码

描述

200

OK

400

请求参数有误

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题：审计实例