更新时间:2026-11-13 GMT+08:00
分享

获取设备信息 - ListDetails

功能介绍

功能介绍:根据设备ID获取指定第三方设备的详细信息,包括设备名称、类型、版本、部署模式、所属子网与虚拟私有云、管理地址、运行状态及关联数据源的策略列表;设备ID需为UUID格式。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/devices/{device_id}/details

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及

device_id

是

String

参数解释:

设备ID,标识一个第三方设备,可通过查询设备列表接口获取

约束限制:

满足正则匹配"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"(UUID格式)

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

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

参数解释:

关联数据源策略列表

取值范围:

不涉及

表4 RelatedDatasourceInfo

参数

参数类型

描述

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(静态脱敏)策略列表,数组中的每个元素为一条静态脱敏策略

取值范围:

不涉及

表5 GdePolicy

参数

参数类型

描述

table

String

参数解释:

表名称

取值范围:

不涉及

columns

Array of Column objects

参数解释:

需加密的列信息,数组元素为Column对象,包含列名、列类型等信息

取值范围:

不涉及

alg

String

参数解释:

加密算法,用于指定脱敏或加密操作所使用的算法类型

取值范围:

action

Integer

参数解释:

操作类型

取值范围:

1-加密

2-解密

表6 DdmPolicy

参数

参数类型

描述

namespace

String

参数解释:

命名空间,HBase特有,动脱专用

取值范围:

不涉及

table

String

参数解释:

表名(如果有模式,则是模式.表)

取值范围:

不涉及

columns

Array of Column objects

参数解释:

列信息,数组元素为Column对象,包含列名、列类型等信息

取值范围:

不涉及

表7 SdmPolicy

参数

参数类型

描述

namespace

String

参数解释:

命名空间,HBase特有,静脱专用

取值范围:

不涉及

table

String

参数解释:

表名(如果有模式,则是模式.表)

取值范围:

不涉及

columns

Array of Column objects

参数解释:

列信息,数组元素为Column对象,包含列名、列类型等信息

取值范围:

不涉及

do_move

Boolean

参数解释:

是否迁移

取值范围:

do_mask

Boolean

参数解释:

是否脱敏

取值范围:

true-是,false-否

表8 Column

参数

参数类型

描述

name

String

参数解释:

列名称

取值范围:

不涉及

mask

Integer

参数解释:

该列所使用的脱敏函数名或ID,动态脱敏策略中该字段必选

取值范围:

不涉及

family

String

参数解释:

列所属表族

取值范围:

不涉及

tag

String

参数解释:

列标签

取值范围:

不涉及

level

String

参数解释:

敏感级别

取值范围:

不涉及

请求示例

获取设备信息

/v1/2b31ed520aabbccddeedb6e571234567/devices/826314dd-1b5b-4037-b976-5f9b7a17df46/details

响应示例

状态码:200

{
  "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
    } ]
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档