文档首页/ 数据安全中心 DSC/ API参考/ API/ 第三方设备管理/ 编辑策略 - UpdateDeviceSecurityPolicy
更新时间:2026-10-20 GMT+08:00
分享

编辑策略 - UpdateDeviceSecurityPolicy

功能介绍

功能介绍:根据策略ID编辑指定项目下的设备安全策略,仅已启用且非下发中/已删除状态的策略可编辑,且编辑后策略类型必须与原策略一致;编辑成功后返回操作结果状态。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及

policy_id

是

Long

参数解释:

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

约束限制:

不涉及

取值范围:

0~9223372036854775807

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释:

安全策略名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

type

是

String

参数解释:

安全策略类型

约束限制:

不涉及

取值范围:

GDE-数据库加密

GDE_DECRYPT-数据库加密(解密)

DOM-数据库运维

DBSS-数据库审计

DDM-数据库动脱

SDM-数据库静脱

默认取值:

不涉及

related_device_id

是

String

参数解释:

关联设备ID,标识与安全策略关联的第三方设备,可通过查询设备列表接口获取

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

related_datasource_id

是

String

参数解释:

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

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

related_datasource_name

否

String

参数解释:

关联数据源名称,用于指定与安全策略关联的数据源名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

related_datasource_type

否

String

参数解释:

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

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

target_datasource_id

否

String

参数解释:

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

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

target_datasource_name

否

String

参数解释:

目标数据源名称,用于指定安全策略的目标数据源名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

target_datasource_type

否

String

参数解释:

目标数据源类型,用于指定安全策略的目标数据源类型

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

policy

是

Array of PolicyInfo objects

参数解释:

策略内容列表,数组中的每个元素为一个PolicyInfo策略信息对象,可包含数据库安全服务策略(dbss_policy)、GDE加密策略(gde_policy)、DOM策略(dom_policy)、DDM脱敏策略(ddm_policy)、SDM脱敏策略(sdm_policy)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

config

否

ConfigInfo object

参数解释:

策略配置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

resource

否

DeviceResourceInfo object

参数解释:

资源

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

target_resource

否

DeviceResourceInfo object

参数解释:

目标资源

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 PolicyInfo

参数

是否必选

参数类型

描述

dbss_policy

否

DbssPolicy object

参数解释:

数据库安全服务策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

gde_policy

否

GdePolicy object

参数解释:

GDE策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dom_policy

否

DomPolicy object

参数解释:

DOM策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ddm_policy

否

DdmPolicy object

参数解释:

DDM策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sdm_policy

否

SdmPolicy object

参数解释:

SDM策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 DbssPolicy

参数

是否必选

参数类型

描述

data_mask

否

Boolean

参数解释:

数据脱敏

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

show_result

否

Boolean

参数解释:

显示结果

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

表6 GdePolicy

参数

是否必选

参数类型

描述

table

否

String

参数解释:

表名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

需加密的列信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

alg

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

  • SM4-国密对称加密算法

  • AES-128-密钥长度128位的AES加密算法

  • AES-256-密钥长度256位的AES加密算法

默认取值:

不涉及

action

否

Integer

参数解释:

操作类型

约束限制:

不涉及

取值范围:

1-加密

2-解密

默认取值:

不涉及

表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

参数解释:

策略默认动作

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表8 DdmPolicy

参数

是否必选

参数类型

描述

namespace

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

table

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

列信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表9 SdmPolicy

参数

是否必选

参数类型

描述

namespace

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

table

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of Column objects

参数解释:

列信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

do_move

否

Boolean

参数解释:

是否迁移

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

do_mask

否

Boolean

参数解释:

是否脱敏

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

表10 Column

参数

是否必选

参数类型

描述

name

否

String

参数解释:

列名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

mask

否

Integer

参数解释:

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

约束限制:

动态脱敏策略中该字段必选

取值范围:

不涉及

默认取值:

不涉及

表11 ConfigInfo

参数

是否必选

参数类型

描述

gde_config

否

GdeConfig object

参数解释:

GDE配置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dom_config

否

DomConfig object

参数解释:

DOM配置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ddm_config

否

DdmConfig object

参数解释:

DDM配置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sdm_config

否

SdmConfig object

参数解释:

SDM配置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表12 GdeConfig

参数

是否必选

参数类型

描述

proxy_port

是

Integer

参数解释:

代理端口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

enc_mode

否

Integer

参数解释:

加密模式

约束限制:

不涉及

取值范围:

1-加密

2-解密

默认取值:

不涉及

表13 DomConfig

参数

是否必选

参数类型

描述

deploy_mode

否

String

参数解释:

数据库运维配置模式

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表14 DdmConfig

参数

是否必选

参数类型

描述

proxy_port

否

Integer

参数解释:

代理端口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

zk_port

否

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

zk_election_port

否

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表15 SdmConfig

参数

是否必选

参数类型

描述

auto_rebuild_target

否

Boolean

参数解释:

是否重建表

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

clear_target

否

Boolean

参数解释:

是否清理目标表

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

skip_dirty_data

否

Boolean

参数解释:

是否跳过脏数据

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

select_type

否

String

参数解释:

数据库静脱配置类型

约束限制:

不涉及

取值范围:

  • ALL-全部

  • PERCENT-百分比抽取

  • ROWNUM-行号脱敏

默认取值:

不涉及

select_param

否

String

参数解释:

抽取方式对应的值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表16 DeviceResourceInfo

参数

是否必选

参数类型

描述

res_id

否

String

参数解释:

设备资源信息ID,标识一条设备资源信息,可通过查询设备资源列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

address

否

String

参数解释:

设备地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

address_type

否

String

参数解释:

设备地址类型,用于指定设备地址的类型(如IP地址)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

port

否

Integer

参数解释:

设备端口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

res_type

否

String

参数解释:

设备资源信息类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

res_version

否

String

参数解释:

资源版本

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

database_name

否

String

参数解释:

数据库名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

account

否

String

参数解释:

账号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

password

否

String

参数解释:

密码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

case_sensitive

否

Boolean

参数解释:

区分大小写敏感

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

extra_params

否

String

参数解释:

额外参数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表17 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

请求示例

编辑策略

{
  "name" : "gde-encrypt-policy-01-updated",
  "type" : "GDE",
  "related_device_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "related_datasource_id" : "c4f3a8e1-2b6d-4e5f-9a8b-7c6d5e4f3a2b",
  "related_datasource_name" : "mysql-datasource-01",
  "related_datasource_type" : "MYSQL",
  "target_datasource_id" : "d5e4b7f2-3c8e-4f6a-9b1c-8d7e6f5a4b3c",
  "target_datasource_name" : "mysql-target-01",
  "target_datasource_type" : "MYSQL",
  "policy" : [ {
    "dbss_policy" : {
      "data_mask" : true,
      "show_result" : true
    },
    "gde_policy" : {
      "table" : "user_info",
      "columns" : [ {
        "name" : "phone_number",
        "mask" : 1
      } ],
      "alg" : "AES-256",
      "action" : 1
    },
    "dom_policy" : {
      "custom_policy" : true,
      "intelligent_protection_baseline" : true,
      "virtual_patch" : true,
      "data_audit" : true,
      "default_action" : "pass"
    },
    "ddm_policy" : {
      "namespace" : "default",
      "table" : "user_info",
      "columns" : [ {
        "name" : "id_card",
        "mask" : 1,
        "comment" : "身份证号"
      } ]
    },
    "sdm_policy" : {
      "namespace" : "default",
      "table" : "user_info",
      "columns" : [ {
        "name" : "email",
        "mask" : 1
      } ],
      "do_move" : true,
      "do_mask" : true
    }
  } ],
  "config" : {
    "gde_config" : {
      "proxy_port" : 8080,
      "enc_mode" : 1
    },
    "dom_config" : {
      "deploy_mode" : "CLOUD"
    },
    "ddm_config" : {
      "proxy_port" : 8081,
      "zk_port" : 2181,
      "zk_election_port" : 2888
    },
    "sdm_config" : {
      "auto_rebuild_target" : true,
      "clear_target" : false,
      "skip_dirty_data" : true,
      "select_type" : "ALL",
      "select_param" : "100"
    }
  },
  "resource" : {
    "res_id" : "e6f5c8a3-4d9f-5b7a-ac2d-9e8f7a6b5c4d",
    "address" : "192.168.0.100",
    "address_type" : "IP",
    "port" : 3306,
    "res_type" : "MYSQL",
    "res_version" : "8.0",
    "database_name" : "user_db",
    "account" : "root",
    "password" : "P@ssw0rd123",
    "case_sensitive" : true,
    "extra_params" : ""
  },
  "target_resource" : {
    "res_id" : "f7a6d9b4-5e0a-6c8b-2d3e-0f1a2b3c4d5e",
    "address" : "192.168.0.200",
    "address_type" : "IP",
    "port" : 5432,
    "res_type" : "POSTGRESQL",
    "res_version" : "15.0",
    "database_name" : "order_db",
    "account" : "admin",
    "password" : "Adm1n@456",
    "case_sensitive" : true,
    "extra_params" : ""
  }
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "编辑策略成功",
  "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
}

状态码

状态码

描述

200

更新成功

错误码

请参见错误码。

相关文档