获取设备列表 - ListDevices
功能介绍
功能介绍:获取指定项目下的第三方设备列表,支持按设备类型、告警模块、严重程度、状态、创建时间等条件过滤,并支持关键字模糊搜索,返回设备总数及分页设备列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/devices
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 以IAM服务接口返回值为准,字符长度为32个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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类型,用于按告警状态过滤查询(多个值以逗号分隔) 约束限制: 每个元素必须为 UNPROCESSED、PROCESSED、IGNORED 之一 取值范围: 默认取值: 不涉及 |
| keywords | 否 | String | 参数解释: 关键字,用于按关键字进行模糊搜索,过滤出名称或描述等匹配的记录 约束限制: 最大长度255字符 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| devices | Array of Device objects | 参数解释: 设备列表 取值范围: 不涉及 |
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 设备名称 取值范围: 不涉及 |
| type | Integer | 参数解释: 设备类型 取值范围: 不涉及 |
| version | String | 参数解释: 设备版本 取值范围: 不涉及 |
| mode | String | 参数解释: 设备模式 取值范围: SINGLE-单机 HA-高可用 CLUSTER-集群 |
| subnet_id | String | 参数解释: 子网ID 取值范围: 不涉及 |
| vpc_id | String | 参数解释: 虚拟私有云ID 取值范围: 不涉及 |
| manage_url | String | 参数解释: 设备URL 取值范围: 不涉及 |
| ip | String | 参数解释: IP地址 取值范围: 不涉及 |
| status | String | 参数解释: 操作结果状态 取值范围: OFFLINE-离线 ACTIVE-可用 CREATING-创建中 MISSING-缺失 ERROR-错误 OK-正常 |
| description | String | 参数解释: 资源描述信息 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| update_time | Long | 参数解释: 更新时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| related_datasource_policy_list | Array of RelatedDatasourceInfo objects | 参数解释: 关联数据源策略列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| datasource_address | String | 参数解释: 数据源地址 取值范围: 不涉及 |
| datasource_port | Integer | 参数解释: 数据源端口 取值范围: 不涉及 |
| datasource_id | String | 参数解释: 数据源ID 取值范围: 不涉及 |
| proxy_port | Integer | 参数解释: 代理端口 取值范围: 不涉及 |
| gde_policies | Array of GdePolicy objects | 参数解释: 加密策略 取值范围: 不涉及 |
| ddm_policies | Array of DdmPolicy objects | 参数解释: 脱敏策略 取值范围: 不涉及 |
| sdm_policies | Array of SdmPolicy objects | 参数解释: SDM(静态脱敏)策略列表,数组中的每个元素为一条静态脱敏策略 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| table | String | 参数解释: 表名称 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 需加密的列信息,数组元素为Column对象,包含列名、列类型等信息 取值范围: 不涉及 |
| alg | String | 参数解释: 加密算法,用于指定脱敏或加密操作所使用的算法类型 取值范围: |
| action | Integer | 参数解释: 操作类型 取值范围: 1-加密 2-解密 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| namespace | String | 参数解释: 命名空间,HBase特有,动脱专用 取值范围: 不涉及 |
| table | String | 参数解释: 表名(如果有模式,则是模式.表) 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 列信息,数组元素为Column对象,包含列名、列类型等信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| namespace | String | 参数解释: 命名空间,HBase特有,静脱专用 取值范围: 不涉及 |
| table | String | 参数解释: 表名(如果有模式,则是模式.表) 取值范围: 不涉及 |
| columns | Array of Column objects | 参数解释: 列信息,数组元素为Column对象,包含列名、列类型等信息 取值范围: 不涉及 |
| do_move | Boolean | 参数解释: 是否迁移 取值范围: |
| do_mask | Boolean | 参数解释: 是否脱敏 取值范围: true-是,false-否 |
请求示例
获取设备列表
/v1/2b31ed520aabbccddeedb6e571234567/devices
响应示例
状态码:200
{
"devices" : [ {
"id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"name" : "firewall-01",
"type" : 1,
"version" : "V1.0.0",
"mode" : "SINGLE",
"subnet_id" : "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
"vpc_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"manage_url" : "https://console.huawei.com/device/management",
"ip" : "192.168.0.1",
"status" : "ACTIVE",
"description" : "核心防火墙设备",
"create_time" : 1700000000000,
"update_time" : 1700100000000,
"related_datasource_policy_list" : [ {
"datasource_address" : "192.168.0.100",
"datasource_port" : 3306,
"datasource_id" : "c4f3a8e1-2b6d-4e5f-9a8b-7c6d5e4f3a2b",
"proxy_port" : 8080,
"gde_policies" : [ {
"table" : "user_info",
"columns" : [ {
"name" : "phone_number",
"mask" : 1
} ],
"alg" : "AES-256",
"action" : 1
} ],
"ddm_policies" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "id_card",
"mask" : 1
} ]
} ],
"sdm_policies" : [ {
"namespace" : "default",
"table" : "user_info",
"columns" : [ {
"name" : "email",
"mask" : 1
} ],
"do_move" : true,
"do_mask" : true
} ]
} ]
} ],
"total" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。