# 获取设备列表 - ListDevices #### 功能介绍 功能介绍：获取设备列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/devices 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页数量限制 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | offset | 否 | Integer | **参数解释：** 分页偏移 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 否 | Array of integers | **参数解释：** 设备类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | module | 否 | Array of strings | **参数解释：** 告警模块 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | severity | 否 | Array of integers | **参数解释：** 告警严重程度 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | create_time | 否 | Long | **参数解释：** 创建时间 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | status | 否 | Array of strings | **参数解释：** 设备状态 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | keywords | 否 | String | **参数解释：** 关键字 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | devices | Array of [Device] objects | **参数解释：** 设备列表 **取值范围：** 不涉及 | | total | Integer | **参数解释：** 总记录数 **取值范围：** 不涉及 | 表5Device | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 创建时间 **取值范围：** 不涉及 | | update_time | Long | **参数解释：** 更新时间 **取值范围：** 不涉及 | | related_datasource_policy_list | Array of [RelatedDatasourceInfo] objects | **参数解释：** 关联数据源策略列表 **取值范围：** 不涉及 | 表6RelatedDatasourceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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策略 **取值范围：** 不涉及 | 表7GdePolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | table | String | **参数解释：** 表名称 **取值范围：** 不涉及 | | columns | Array of [Column] objects | **参数解释：** 需加密的列信息 **取值范围：** 不涉及 | | alg | String | **参数解释：** 加密算法，SM4、AES-128、AES-256 **取值范围：** 不涉及 | | action | Integer | **参数解释：** 操作类型 **取值范围：** 不涉及 | 表8DdmPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释：** 命名空间，HBase特有，动脱专用 **取值范围：** 不涉及 | | table | String | **参数解释：** 表名（如果有模式，则是模式.表） **取值范围：** 不涉及 | | columns | Array of [Column] objects | **参数解释：** 列信息 **取值范围：** 不涉及 | 表9SdmPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释：** 命名空间，HBase特有，动脱专用 **取值范围：** 不涉及 | | table | String | **参数解释：** 表名（如果有模式，则是模式.表） **取值范围：** 不涉及 | | columns | Array of [Column] objects | **参数解释：** 列信息 **取值范围：** 不涉及 | | do_move | Boolean | **参数解释：** 是否迁移 **取值范围：** true-是，false-否 | | do_mask | Boolean | **参数解释：** 是否脱敏 **取值范围：** true-是，false-否 | 表10Column | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 列名称 **取值范围：** 不涉及 | | enc_status | Integer | **参数解释：** 加密状态 **取值范围：** 不涉及 | | comment | String | **参数解释：** 列注释 **取值范围：** 不涉及 | #### 请求示例 获取设备列表 ``` /v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/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", "enc_status" : 1, "comment" : "用户手机号" } ], "alg" : "aes-256", "action" : 1 } ], "ddm_policies" : [ { "namespace" : "default", "table" : "user_info", "columns" : [ { "name" : "id_card", "enc_status" : 1, "comment" : "身份证号" } ] } ], "sdm_policies" : [ { "namespace" : "default", "table" : "user_info", "columns" : [ { "name" : "email", "enc_status" : 1, "comment" : "用户邮箱" } ], "do_move" : true, "do_mask" : true } ] } ] }, { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "dbss-02", "type" : 2, "version" : "V2.1.0", "mode" : "HA", "subnet_id" : "b2c3d4e5-f6a7-4890-bcde-f12345678901", "vpc_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "manage_url" : "https://console.huawei.com/device/dbss", "ip" : "192.168.0.2", "status" : "OFFLINE", "description" : "数据库安全审计设备", "create_time" : 1700000000000, "update_time" : 1700100000000, "related_datasource_policy_list" : [ ] } ], "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。