文档首页/数据安全中心 DSC/API参考/API说明/策略中心/查询安全策略列表 - ShowSecurityPolicies
更新时间：2025-11-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询安全策略列表 - ShowSecurityPolicies

功能介绍

查询项目中的安全策略配置列表

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/security-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识符

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示数量

name

否

String

策略名称（用于筛选）

offset

否

Integer

分页偏移量

type

否

String

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

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

policy_list

Array of PolicyResponse objects

策略信息列表

total

Long

策略总数

表4 PolicyResponse

参数

参数类型

描述

dbss_policy

DbssPolicy object

数据库审计策略信息

ddm_config

DdmConfig object

动态脱敏策略信息

ddm_policy_list

Array of DdmPolicy objects

array

dom_config

DomConfig object

数据库运维策略信息（暂不支持）

dom_policy

DomPolicy object

数据库运维策略信息

enabled

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_instance_id

String

执行策略的实例ID

related_instance_name

String

执行策略的实例名称

related_instance_type

String

执行策略的实例类型

resource

ResourceInfo object

数据源信息

status

String

策略的状态

type

String

策略类型

update_time

Long

策略更新时间

表5 DbssPolicy

参数

参数类型

描述

data_mask

Boolean

隐私数据脱敏

show_result

Boolean

是否显示结果集

表6 DdmConfig

参数

参数类型

描述

proxy_port

Integer

代理端口

zk_election_port

Integer

自定义ZK选举端口，大数据类型（HBase和Hive）才有

zk_port

Integer

自定义的ZK端口，大数据类型（HBase和Hive）才有

表7 DdmPolicy

参数

参数类型

描述

columns

Array of Column objects

策略配置的列信息列表

namespace

String

命名空间名称

table

String

表名称

表8 DomConfig

参数

参数类型

描述

deploy_mode

String

部署模式

表9 DomPolicy

参数

参数类型

描述

custom_policy

Boolean

是否启用自定义策略

data_audit

Boolean

是否进行数据审计

default_action

String

策略默认动作，pass/block/audit/…

intelligent_protection_baseline

Boolean

是否启用智能防护基线

virtual_patch

Boolean

是否启用虚拟补丁

表10 GdeConfig

参数

参数类型

描述

enc_mode

Integer

加密模式，1：加密，2：解密

proxy_port

Integer

代理端口

表11 GdePolicy

参数

参数类型

描述

action

Integer

1加密，2解密

alg

String

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

columns

Array of Column objects

需加密的列信息

table

String

表名称

表12 Column

参数

参数类型

描述

mask

Integer

脱敏算法名称或ID

name

String

列名称

表13 ResourceInfo

参数

参数类型

描述

account

String

数据库用户名

address

String

数据库地址

address_type

String

地址类型（IPV4、IPV6）

case_sensitive

Boolean

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

指定的项目不存在

错误码

请参见错误码。

父主题：策略中心

相关文档