文档首页/ 数据安全中心 DSC/ API参考/ API/ 安全策略管理/ 编辑安全策略 - UpdateSecurityPolicyById
更新时间:2026-11-13 GMT+08:00
分享

编辑安全策略 - UpdateSecurityPolicyById

功能介绍

功能介绍:编辑指定安全策略,可修改策略名称、关联实例、数据源及策略配置内容,编辑后策略即刻生效。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

PUT /v1/{project_id}/security-policies/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

policy_id

是

String

参数解释:

安全策略ID,可通过查询安全策略列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释:

安全策略名称

约束限制:

可选,最大256字符,仅允许中文、英文字母、数字、下划线、连字符

取值范围:

不涉及

默认取值:

不涉及

type

否

String

参数解释:

安全策略类型

约束限制:

不涉及

取值范围:

  • GDE-数据库加密

  • GDE_DECRYPT-数据库加密(解密)

  • DOM-数据库运维

  • DBSS-数据库审计

  • DDM-数据库动脱

  • SDM-数据库静脱

默认取值:

不涉及

instance_id

是

String

参数解释:

实例ID,标识安全策略关联的数据实例,可通过查询实例列表接口获取

约束限制:

必填,非空字符串

取值范围:

不涉及

默认取值:

不涉及

instance_name

否

String

参数解释:

安全策略关联的实例名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

datasource_id

是

String

参数解释:

数据源ID,标识安全策略关联的数据源,可通过查询数据源列表接口获取

约束限制:

必填,非空字符串

取值范围:

不涉及

默认取值:

不涉及

datasource_name

否

String

参数解释:

安全策略关联的数据源名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

datasource_type

是

String

参数解释:

数据源类型,用于指定安全策略关联的数据源类别

约束限制:

必填,非空字符串

取值范围:

  • OBS-对象存储服务

  • DB-数据库

  • BIGDATA-大数据

  • DWS-数据仓库服务

  • ES-Elasticsearch搜索引擎

默认取值:

不涉及

policy

否

Array of PolicyInfo objects

参数解释:

策略内容,按策略类型包含对应的子策略(GDE/DDM/DOM/SDM/DBSS)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

config

否

ConfigInfo object

参数解释:

策略配置,按策略类型包含对应的子配置(GDE/DDM/DOM/SDM)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

resource

否

ResourceInfo object

参数解释:

资源信息,包含数据库资源实例的连接信息(地址、端口、账号、密码等)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 PolicyInfo

参数

是否必选

参数类型

描述

dbss_policy

否

DbssPolicy object

参数解释:

DBSS数据库审计策略,type为DBSS时有效

取值范围:

不涉及

gde_policy

否

GdePolicy object

参数解释:

GDE数据库加密策略,type为GDE时有效

取值范围:

不涉及

dom_policy

否

DomPolicy object

参数解释:

DOM数据库运维策略,type为DOM时有效

取值范围:

不涉及

ddm_policy

否

DdmPolicy object

参数解释:

DDM数据库动脱策略,type为DDM时有效

取值范围:

不涉及

sdm_policy

否

SdmPolicy object

参数解释:

SDM数据库静脱策略,type为SDM时有效

取值范围:

不涉及

表5 DbssPolicy

参数

是否必选

参数类型

描述

data_mask

否

Boolean

参数解释:

是否启用数据脱敏

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

show_result

否

Boolean

参数解释:

是否显示脱敏结果

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

表6 GdePolicy

参数

是否必选

参数类型

描述

table

否

String

参数解释:

数据库表名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

需要脱敏的列信息列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

alg

否

String

参数解释:

脱敏算法名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

action

否

Integer

参数解释:

操作类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表7 DomPolicy

参数

是否必选

参数类型

描述

custom_policy

否

Boolean

参数解释:

是否启用自定义策略

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

intelligent_protection_baseline

否

Boolean

参数解释:

是否启用智能防护基线

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

virtual_patch

否

Boolean

参数解释:

是否启用虚拟补丁

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

data_audit

否

Boolean

参数解释:

是否启用数据审计

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

default_action

否

String

参数解释:

策略默认动作

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

表8 DdmPolicy

参数

是否必选

参数类型

描述

namespace

否

String

参数解释:

命名空间,用于标识数据脱敏策略的作用范围

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

table

否

String

参数解释:

数据库表名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

需要脱敏的列信息列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表9 SdmPolicy

参数

是否必选

参数类型

描述

namespace

否

String

参数解释:

命名空间

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

table

否

String

参数解释:

表名

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

列列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

do_move

否

Boolean

参数解释:

是否移动

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

do_mask

否

Boolean

参数解释:

是否脱敏

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

表10 Column

参数

是否必选

参数类型

描述

name

否

String

参数解释:

列名称

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

family

否

String

参数解释:

列族名称,用于数据库中的列分组

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

level

否

String

参数解释:

脱敏级别,用于标识列的脱敏优先级或敏感程度

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

mask

否

Integer

参数解释:

脱敏标识,1表示需要脱敏,0表示不需要脱敏

约束限制:

不涉及

取值范围:

  • 0:不脱敏

  • 1:脱敏

默认取值:

不涉及

tag

否

String

参数解释:

标签

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

表11 ConfigInfo

参数

是否必选

参数类型

描述

gde_config

否

GdeConfig object

参数解释:

GDE加密配置,type为GDE时有效

取值范围:

不涉及

dom_config

否

DomConfig object

参数解释:

DOM运维配置,type为DOM时有效

取值范围:

不涉及

ddm_config

否

DdmConfig object

参数解释:

DDM动脱配置,type为DDM时有效

取值范围:

不涉及

sdm_config

否

SdmConfig object

参数解释:

SDM静脱配置,type为SDM时有效

取值范围:

不涉及

表12 GdeConfig

参数

是否必选

参数类型

描述

proxy_port

是

Integer

参数解释:

代理端口

取值范围:

不涉及

enc_mode

否

Integer

参数解释:

加密模式

取值范围:

不涉及

表13 DomConfig

参数

是否必选

参数类型

描述

deploy_mode

否

String

参数解释:

部署模式

取值范围:

不涉及

表14 DdmConfig

参数

是否必选

参数类型

描述

proxy_port

否

Integer

参数解释:

代理端口

取值范围:

不涉及

zk_port

否

Integer

参数解释:

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

取值范围:

不涉及

zk_election_port

否

Integer

参数解释:

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

取值范围:

不涉及

表15 SdmConfig

参数

是否必选

参数类型

描述

auto_rebuild_target

否

Boolean

参数解释:

是否重建目标表

取值范围:

true-是,false-否

clear_target

否

Boolean

参数解释:

是否清理目标表

取值范围:

true-是,false-否

skip_dirty_data

否

Boolean

参数解释:

是否跳过脏数据

取值范围:

true-是,false-否

select_type

否

String

参数解释:

抽取类型,对应SdmSelectTypeEnum枚举

取值范围:

不涉及

select_param

否

String

参数解释:

抽取方式对应的值

取值范围:

不涉及

表16 ResourceInfo

参数

是否必选

参数类型

描述

resId

否

String

参数解释:

资源ID

取值范围:

不涉及

address

否

String

参数解释:

地址

取值范围:

不涉及

addressType

否

String

参数解释:

地址类型

取值范围:

不涉及

port

否

Integer

参数解释:

端口

取值范围:

不涉及

resType

否

String

参数解释:

资源类型

取值范围:

不涉及

resVersion

否

String

参数解释:

资源版本

取值范围:

不涉及

databaseName

否

String

参数解释:

数据库名称

取值范围:

不涉及

account

否

String

参数解释:

账号

取值范围:

不涉及

password

否

String

参数解释:

密码

取值范围:

不涉及

caseSensitive

否

Boolean

参数解释:

是否大小写敏感

取值范围:

true-是,false-否

extraParams

否

String

参数解释:

额外参数

取值范围:

不涉及

响应参数

状态码:200

表17 响应Body参数

参数

参数类型

描述

-

Integer

参数解释:

编辑后的安全策略ID

取值范围:

不涉及

请求示例

编辑安全策略请求体

{
  "name" : "gde-security-policy-01",
  "type" : "GDE",
  "instance_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
  "instance_name" : "dbss-instance-01",
  "datasource_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "datasource_name" : "customer-mysql-ds",
  "datasource_type" : "MYSQL",
  "policy" : [ {
    "gde_policy" : {
      "table" : "customer_info",
      "columns" : [ {
        "name" : "phone",
        "mask" : 1
      }, {
        "name" : "id_card",
        "mask" : 1
      } ],
      "alg" : "SM4",
      "action" : 1
    }
  } ],
  "config" : {
    "gde_config" : {
      "proxy_port" : 8080,
      "enc_mode" : 1
    }
  },
  "resource" : {
    "resId" : "db-resource-01",
    "address" : "192.168.1.100",
    "addressType" : "IP",
    "port" : 3306,
    "resType" : "MYSQL",
    "resVersion" : "8.0",
    "databaseName" : "customer_db",
    "account" : "root",
    "password" : "******",
    "caseSensitive" : false,
    "extraParams" : ""
  }
}

响应示例

状态码:200

1001

状态码

状态码

描述

200

编辑安全策略成功,返回编辑后的安全策略ID(裸long数字,非包装对象)

错误码

请参见错误码。

相关文档