更新时间:2025-09-12 GMT+08:00
分享

查询策略列表

功能介绍

查询项目中所有设备的安全策略列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/devices/security-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示数量

name

String

策略名称(用于筛选)

offset

Integer

分页偏移量

type

String

策略类型(GDE-数据库加密, GDE_DECRYPT-数据库解密, DOM-数据库运维, DBSS-数据库安全服务, DDM-数据库动态脱敏, SDM-数据库静态脱敏)

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

policy_list

Array of DevicePolicyDetail objects

策略信息列表

total

Long

策略总数

表4 DevicePolicyDetail

参数

参数类型

描述

ddm_config

DdmConfig object

动态脱敏策略信息

ddm_policy_list

Array of DdmPolicy objects

array

enabled

Boolean

boolean

gde_config

GdeConfig object

数据库加密策略信息

gde_policy

GdePolicy object

加密策略信息

id

Long

策略ID

name

String

策略名称

related_datasource_id

String

关联的数据库ID

related_datasource_name

String

关联的数据库名称

related_datasource_type

String

关联的数据库类型

related_device_id

String

执行策略的设备ID

related_device_name

String

执行策略的设备名称

related_device_type

Integer

执行策略的设备类型

resource

DeviceResourceInfo object

设备内安全策略关联资源信息

sdm_config

SdmConfig object

静态脱敏策略信息

sdm_policy_list

Array of SdmPolicy objects

array

status

String

策略状态

target_datasource_id

String

静脱策略的目标数据库ID

target_datasource_name

String

静脱策略的目标数据库名称

target_datasource_type

String

静脱策略的目标数据库类型

target_resource

DeviceResourceInfo object

设备内安全策略关联资源信息

type

String

策略类型

update_time

Long

更新时间

表5 DdmConfig

参数

参数类型

描述

proxy_port

Integer

代理端口

zk_election_port

Integer

自定义ZK选举端口,大数据类型(HBase和Hive)才有

zk_port

Integer

自定义的ZK端口,大数据类型(HBase和Hive)才有

表6 DdmPolicy

参数

参数类型

描述

columns

Array of Column objects

策略配置的列信息列表

namespace

String

命名空间名称

table

String

表名称

表7 GdeConfig

参数

参数类型

描述

enc_mode

Integer

加密模式,1:加密,2:解密

proxy_port

Integer

代理端口

表8 GdePolicy

参数

参数类型

描述

action

Integer

1加密,2解密

alg

String

加密算法,sm4、aes-128、aes-256

columns

Array of Column objects

需加密的列信息

table

String

表名称

表9 SdmConfig

参数

参数类型

描述

auto_rebuild_target

Boolean

是否重建表

clear_target

Boolean

是否清理目标表

select_param

String

抽取方式对应的值

select_type

String

抽取类型

skip_dirty_data

Boolean

是否跳过脏数据

表10 SdmPolicy

参数

参数类型

描述

columns

Array of Column objects

列信息

do_mask

Boolean

是否脱敏

do_move

Boolean

是否迁移

namespace

String

命名空间,HBase特有

table

String

表名称

表11 Column

参数

参数类型

描述

mask

Integer

脱敏算法名称或ID

name

String

列名称

表12 DeviceResourceInfo

参数

参数类型

描述

account

String

用户名

address

String

地址

address_type

String

地址类型(ipv4、ipv)

case_sensitive

Boolean

\

database_name

String

数据库名称

extra_params

String

预留字段

password

String

密码

port

Integer

端口

res_id

String

数据库ID

res_type

String

数据库类型

res_version

String

数据库版本

请求示例

响应示例

状态码

状态码

描述

200

查询结果

401

未授权,用户未登录或令牌无效

403

无权限访问该资源

404

指定的项目不存在

错误码

请参见错误码

相关文档