文档首页/ 数据安全中心 DSC/ API参考/ API/ 第三方设备管理/ 获取设备状态列表 - ListMonitorInfos
更新时间:2026-10-20 GMT+08:00
分享

获取设备状态列表 - ListMonitorInfos

功能介绍

功能介绍:获取指定项目下第三方设备的监控状态列表,包括操作系统信息、许可证信息、IP地址与运行状态,支持按设备类型、模块、严重程度、创建时间等条件过滤,返回设备总数及分页监控信息列表。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/devices/monitor-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

满足正则匹配"^[a-z0-9]{32}$"

取值范围:

以IAM服务接口返回值为准,字符长度为32个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

1~1000

默认取值:

100(不传时默认取100)

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0及以上

默认取值:

0(不传时默认取0)

type

否

Array of integers

参数解释:

设备类型列表,数组中的每个元素为设备类型(Integer),用于按设备类型过滤查询

约束限制:

不涉及

取值范围:

0-应用数据审计

1-应用数据安全网关

2-数据库防火墙

3-数据库加密

4-静态脱敏实例

5-数据库动脱实例

默认取值:

不涉及

module

否

Array of strings

参数解释:

告警模块列表,数组中的每个元素为告警模块(String),用于按告警模块过滤查询

约束限制:

不涉及

取值范围:

SYSTEM-系统告警

SERVICE-业务告警

默认取值:

不涉及

severity

否

Array of integers

参数解释:

告警严重程度列表,数组中的每个元素为告警严重程度(Integer),用于按告警严重程度过滤查询

约束限制:

不涉及

取值范围:

1-致命

2-严重

3-次要

4-警告

5-不确定

6-已清除

默认取值:

不涉及

create_time

否

String

参数解释:

创建时间筛选,用于按设备创建时间过滤

约束限制:

不涉及

取值范围:

0-今天

1-近1天

2-近3天

3-近7天

4-近30天

默认取值:

不涉及

status

否

Array of strings

参数解释:

设备状态列表,数组中的每个元素为设备状态(String),用于按设备状态过滤查询

约束限制:

不涉及

取值范围:

OFFLINE-离线

ACTIVE-可用

CREATING-创建中

MISSING-缺失

ERROR-错误

OK-正常

默认取值:

不涉及

keywords

否

String

参数解释:

关键字,用于按关键字进行模糊搜索,过滤出名称或描述等匹配的记录

约束限制:

最大长度255字符

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

monitor_infos

Array of MonitorInfo objects

参数解释:

监控信息列表

取值范围:

不涉及

total

Integer

参数解释:

总记录数

取值范围:

不涉及

表5 MonitorInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

监控名称

取值范围:

不涉及

type

Integer

参数解释:

监控类型

取值范围:

不涉及

os_info

OsInfo object

参数解释:

操作系统信息

取值范围:

不涉及

license_info

LicenseInfo object

参数解释:

许可证信息

取值范围:

不涉及

ip

String

参数解释:

IP地址

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

  • OFFLINE-离线

  • ACTIVE-可用

  • CREATING-创建中

  • MISSING-缺失

  • ERROR-错误

  • OK-正常

description

String

参数解释:

资源描述信息

取值范围:

不涉及

表6 OsInfo

参数

参数类型

描述

cpu

String

参数解释:

CPU核心数

取值范围:

不涉及

mem

String

参数解释:

内存大小,单位为GB

取值范围:

不涉及

disk

String

参数解释:

磁盘容量,单位为GB

取值范围:

不涉及

表7 LicenseInfo

参数

参数类型

描述

license

String

参数解释:

许可证信息

取值范围:

不涉及

license_start

Long

参数解释:

许可证开始时间

取值范围:

不涉及

license_end

Long

参数解释:

许可证结束时间

取值范围:

不涉及

请求示例

获取设备状态列表

/v1/2b31ed520aabbccddeedb6e5712345678/devices/monitor-info

响应示例

状态码:200

{
  "monitor_infos" : [ {
    "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "name" : "firewall-01",
    "type" : 1,
    "os_info" : {
      "cpu" : "8C",
      "mem" : "16GB",
      "disk" : "500GB"
    },
    "license_info" : {
      "license" : "DSC-PREMIUM-2024",
      "license_start" : 1700000000000,
      "license_end" : 1730000000000
    },
    "ip" : "192.168.0.1",
    "status" : "ACTIVE",
    "description" : "核心防火墙设备"
  }, {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "name" : "dbss-02",
    "type" : 2,
    "os_info" : {
      "cpu" : "4C",
      "mem" : "8GB",
      "disk" : "200GB"
    },
    "license_info" : {
      "license" : "DSC-STANDARD-2024",
      "license_start" : 1700000000000,
      "license_end" : 1730000000000
    },
    "ip" : "192.168.0.2",
    "status" : "OFFLINE",
    "description" : "数据库安全审计设备"
  } ],
  "total" : 2
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档