# 查询安全策略 - ShowSecurityPolicy #### 功能介绍 功能介绍：查询安全策略 #### 接口约束 - 无特殊约束。 #### 调用方法 请参见[如何调用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}/security-policies 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释：** 策略类型 **约束限制：** 不涉及 **取值范围：** - GDE：数据库加密 - GDE_DECRYPT：数据库加密(解密) - DOM：数据库运维 - DBSS：数据库审计 - DDM：数据库动脱 - SDM：数据库静脱 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 策略名称 **约束限制：** 不涉及 **取值范围：** 1-256个字符 **默认取值：** 不涉及 | | offset | 否 | Integer | **参数解释：** 偏移量，表示从该偏移量开始查询 **约束限制：** 不涉及 **取值范围：** 0-2147483647 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 每页个数 **约束限制：** 不涉及 **取值范围：** 1-200 **默认取值：** 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释：** 总记录数 **取值范围：** 不涉及 | | policy_list | Array of [PolicyResponse] objects | **参数解释：** 策略详情列表 **取值范围：** 不涉及 | 表5PolicyResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释：** 资源ID，唯一标识 **取值范围：** 不涉及 | | name | String | **参数解释：** 安全策略名称 **取值范围：** 不涉及 | | type | String | **参数解释：** 安全策略类型 **取值范围：** - GDE：数据库加密 - GDE_DECRYPT：数据库加密(解密) - DOM：数据库运维 - DBSS：数据库审计 - DDM：数据库动脱 - SDM：数据库静脱 | | related_instance_id | String | **参数解释：** 策略响应ID **取值范围：** 不涉及 | | related_instance_name | String | **参数解释：** 关联实例名称 **取值范围：** 不涉及 | | related_instance_type | String | **参数解释：** 关联实例类型 **取值范围：** - DISTRIBUTED-分布式 - PRIMARY_STANDBY-主备模式 - UNRECOGNIZED-未识别 | | related_datasource_id | String | **参数解释：** 关联数据源ID **取值范围：** 不涉及 | | related_datasource_name | String | **参数解释：** 关联数据源名称 **取值范围：** 不涉及 | | related_datasource_type | String | **参数解释：** 关联数据源类型 **取值范围：** 不涉及 | | enabled | Boolean | **参数解释：** 是否启用 **取值范围：** true-是，false-否 | | status | String | **参数解释：** 操作结果状态 **取值范围：** - SENDING: 下发中 - SUCCESS: 下发成功 - DECRYPTING: 解密中 - FAIL: 下发失败 - DELETED: 已删除 | | update_time | Long | **参数解释：** 策略响应时间 **取值范围：** 不涉及 | | dbss_policy | [DbssPolicy] object | **参数解释：** 数据库审计策略 **取值范围：** 不涉及 | | gde_policy | [GdePolicy] object | **参数解释：** 动态数据加密策略 **取值范围：** 不涉及 | | ddm_policy_list | Array of [DdmPolicy] objects | **参数解释：** 动态数据脱敏策略列表 **取值范围：** 不涉及 | | dom_policy | [DomPolicy] object | **参数解释：** 运维策略 **取值范围：** 不涉及 | | gde_config | [GdeConfig] object | **参数解释：** 动态数据加密配置 **取值范围：** 不涉及 | | dom_config | [DomConfig] object | **参数解释：** 运维配置 **取值范围：** 不涉及 | | ddm_config | [DdmConfig] object | **参数解释：** 动态数据脱敏配置 **取值范围：** 不涉及 | | resource | [ResourceInfo] object | **参数解释：** 资源信息 **取值范围：** 不涉及 | 表6DbssPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_mask | Boolean | **参数解释：** 是否启用数据脱敏 **取值范围：** true-是，false-否 | | show_result | Boolean | **参数解释：** 是否显示脱敏结果 **取值范围：** true-是，false-否 | 表7GdePolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | table | String | **参数解释：** 数据库表名称 **取值范围：** 不涉及 | | columns | Array of [Column] objects | **参数解释：** 需要脱敏的列信息列表 **取值范围：** 不涉及 | | alg | String | **参数解释：** 脱敏算法名称 **取值范围：** 不涉及 | | action | Integer | **参数解释：** 操作类型 **取值范围：** 不涉及 | 表8DdmPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释：** 命名空间，用于标识数据脱敏策略的作用范围 **取值范围：** 不涉及 | | table | String | **参数解释：** 数据库表名称 **取值范围：** 不涉及 | | columns | Array of [Column] objects | **参数解释：** 需要脱敏的列信息列表 **取值范围：** 不涉及 | 表9Column | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 列名称 **取值范围：** 不涉及 | | family | String | **参数解释：** 列族名称，用于数据库中的列分组 **取值范围：** 不涉及 | | level | String | **参数解释：** 级别 **取值范围：** 不涉及 | | mask | Integer | **参数解释：** 脱敏 **取值范围：** 不涉及 | | tag | String | **参数解释：** 标签 **取值范围：** 不涉及 | 表10DomPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | custom_policy | Boolean | **参数解释：** 是否启用自定义策略 **取值范围：** true-是，false-否 | | intelligent_protection_baseline | Boolean | **参数解释：** 是否启用智能防护基线 **取值范围：** true-是，false-否 | | virtual_patch | Boolean | **参数解释：** 是否启用虚拟补丁 **取值范围：** true-是，false-否 | | data_audit | Boolean | **参数解释：** 是否启用数据审计 **取值范围：** true-是，false-否 | | default_action | String | **参数解释：** 策略默认动作 **取值范围：** 不涉及 | 表11GdeConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | config | String | **参数解释：** GDE配置 **取值范围：** 不涉及 | | enc_mode | Integer | **参数解释：** 加密模式 **取值范围：** 不涉及 | | proxy_port | Integer | **参数解释：** 代理端口 **取值范围：** 不涉及 | 表12DomConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | config | String | **参数解释：** DOM配置 **取值范围：** 不涉及 | | deploy_mode | String | **参数解释：** 部署模式 **取值范围：** 不涉及 | 表13DdmConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | config | String | **参数解释：** DDM配置 **取值范围：** 不涉及 | | proxy_port | Integer | **参数解释：** 代理端口 **取值范围：** 不涉及 | | zk_election_port | Integer | **参数解释：** ZooKeeper选举端口 **取值范围：** 不涉及 | | zk_port | Integer | **参数解释：** ZooKeeper端口 **取值范围：** 不涉及 | 表14ResourceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | address | String | **参数解释：** 连接地址 **取值范围：** 不涉及 | | port | Integer | **参数解释：** 端口号 **取值范围：** 不涉及 | | account | String | **参数解释：** 账号 **取值范围：** 不涉及 | | password | String | **参数解释：** 密码 **取值范围：** 不涉及 | | address_type | String | **参数解释：** 资源信息类型 **取值范围：** 不涉及 | | case_sensitive | Boolean | **参数解释：** 是否大小写敏感 **取值范围：** true-是，false-否 | | database_name | String | **参数解释：** 数据库名称 **取值范围：** 不涉及 | | extra_params | String | **参数解释：** 扩展参数 **取值范围：** 不涉及 | | res_id | String | **参数解释：** 资源信息ID **取值范围：** 不涉及 | | res_type | String | **参数解释：** 资源信息类型 **取值范围：** 不涉及 | | res_version | String | **参数解释：** 资源版本 **取值范围：** 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** ``` { "total" : 1, "policy_list" : [ { "id" : 1001, "name" : "gde-security-policy-01", "type" : "GDE", "related_instance_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "related_instance_name" : "dbss-instance-01", "related_instance_type" : "DISTRIBUTED", "related_datasource_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "related_datasource_name" : "customer-mysql-ds", "related_datasource_type" : "MYSQL", "enabled" : true, "status" : "SUCCESS", "update_time" : 1700000600000, "dbss_policy" : { "data_mask" : true, "show_result" : true }, "gde_policy" : { "table" : "customer_info", "columns" : [ { "name" : "phone", "family" : "default" } ], "alg" : "SHA256", "action" : 1 }, "ddm_policy_list" : [ { "namespace" : "customer_ns", "table" : "customer_info", "columns" : [ { "name" : "phone", "family" : "default" } ] } ], "dom_policy" : { "custom_policy" : true, "intelligent_protection_baseline" : true, "virtual_patch" : true, "data_audit" : true, "default_action" : "ALLOW" }, "gde_config" : { "config" : "{}" }, "dom_config" : { "config" : "{}" }, "ddm_config" : { "config" : "{}" }, "resource" : { "res_id" : "c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f", "address" : "192.168.1.100", "address_type" : "IP", "port" : 3306, "res_type" : "MYSQL", "res_version" : "8.0", "database_name" : "customer_db", "account" : "dsc_scan_user", "password" : "P@ssw0rd_encrypted", "case_sensitive" : true, "extra_params" : "{}" } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。