华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 rules Array of ResponseRule objects 规则列表 total Integer 规则总数 表4 ResponseRule 参数 参数类型 描述 category String 规则类别，内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值： BUILT_IN BUILT_SELF delete_allowed Boolean 是否允许删除 group_names String 相关的规则组 id String 规则ID logic_operator String 逻辑运算符，"AND","OR","REGEX" min_match Integer 最小匹配次数 risk_level Integer 风险等级 rule_content String 规则内容 rule_desc String 规则描述 rule_name String 规则名称 rule_type String 规则类型，关键字(KEYWORD)、正则表达式(REGEX)或自然语言(NLP) 枚举值： KEYWORD REGEX NLP selected Boolean 是否可选 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

约束与限制 DSC支持的文档和图片水印兼容的范围如表1。 表1 文档/图片水印支持的类型 文档/图片水印载体 Office(Windows、Mac) WPS(Windows、Mac、Linux、手机端) Adobe Reader 浏览器(chrome、Edge) 福昕PDF PDF - √ √ √ √ WORD √ √ - - - EXCEL √ √ - - - PPT √ √ - - - “√”表示支持，“-”表示平台不支持。 DSC的API接口暂不支持直接对OBS桶数据进行添加/提取水印的操作，如果您需要对OBS桶数据进行水印相关的操作，请先将OBS桶数据读取到本地，再调用水印的API接口进行操作，添加水印后的文档将放在API的响应体中进行返回。 更详细的限制请参见具体API的说明。 父主题： 使用前必读

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 项目所在region的id，如：xx-xx-1。 doc_type 是 String 待提取水印的文档类型 枚举值： WORD EXCEL PDF PPT src_file 是 String 待提取文字暗水印的文档的地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 file_password 否 String 解密文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。

修订记录 发布日期 修改说明 2024-03-30 第十五次正式发布。 删除： “数据库血缘图数据库及查询”接口。 “数据库血缘图表分页查询”接口。 “数据库血缘图字段查询”接口。 “OBS血缘图桶级查询”接口。 “OBS血缘图文件分页查询”接口。 新增： “删除扫描任务”接口。 2022-12-09 第十四次正式发布。 新增： “资源管理”相关的接口。 “告警通知”相关的接口。 “资产管理”相关的接口。 “数据静态脱敏”相关的接口。 “API调用记录”相关的接口。 2022-07-08 第十三次正式发布。 “region_id”参数举例更新。 2022-04-15 第十二次正式发布。 修改“嵌入数据水印”接口。 2021-12-13 第十一次正式发布。 更新“嵌入文档水印”接口。 2021-11-10 第十次发布。 修改终端节点章节。 增加敏感数据相关接口。 2021-09-28 第九次正式发布。 API按规范优化。 2021-09-14 第八次正式发布。 修改终端节点章节。 2021-09-09 第七次正式发布。 修改约束与限制，增加水印的约束限制。 2021-07-22 第六次正式发布。 API优化。 2021-04-28 第五次正式发布。 API接口按规范整改。 2021-04-16 第四次正式发布。 错误码按规范整改。 2021-04-07 第三次正式发布。 增加“图片水印”章节。 2021-03-11 第二次正式发布。 修改“图片水印”章节，支持PPT文件添加水印。 2020-11-24 第一次正式发布。

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 buckets 否 Array of BucketBean objects OBS桶列表 表4 BucketBean 参数 是否必选 参数类型 描述 asset_name 否 String 资产名称 location 否 String 桶位置 bucket_name 否 String 桶名称 bucket_policy 否 String 桶策略

请求示例 添加桶名称为xxxx的数据资产扫描授权。 POST /v1/{project_id}/sdg/asset/obs/buckets { "buckets" : [ { "asset_name" : "xxxx", "location" : "xxxx", "bucket_name" : "xxxx", "bucket_policy" : "private" } ] }

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 DSC.00000001 The project ID is not in the trust list Project ID不在白名单列表中! 请重试或联系技术支持。 400 DSC.00000002 Internal service error 内部错误! 请重试或联系技术支持。 400 DSC.00000003 Failed to read the upload file 读取文件错误! 请检查文件类型和大小。 400 DSC.00000004 Invalid parameter 参数错误! 请传递正确的参数。 400 DSC.00000005 Invalid project id Project ID长度错误! 请重试或联系技术支持。 400 DSC.00000006 File size exceeds maximum limit 上传文件超过最大限制! 请检查文件的大小。 400 DSC.00000007 File format error 文件格式错误! 请检查文件的格式。 400 DSC.00000008 Upload file is empty 上传文件为空! 请检查文件内容是否为空。 400 DSC.00000009 There are many tasks at present. Please try again later 当前任务较多，请稍后再试！ 请重试或联系技术支持。 400 DSC.00000010 Image watermark file is empty 文档图形水印文件为空! 请添加图形文件。 400 DSC.00000011 Image watermark file exceeds maximum limit 文档图形水印文件超过最大限制! 请限制图形文件大小。 400 DSC.00000012 Invalid project image watermark file type 文档图形水印类型错误! 请上传.png或.jpg格式的文件。 400 DSC.00000013 Invalid Auth 认证失败! 请使用有效token。 400 DSC.00000014 Order DSC prossional version 请订购DSC专业版本! 请订购DSC专业版本。 400 mask.20000001 Unknown error 未知错误! 请重试或联系技术支持。 400 mask.20000002 Internal service error 内部错误! 请重试或联系技术支持。 400 mask.20000003 Invalid parameter 参数错误！ 请传递正确的参数 400 mask.20000004 Mask data failed 数据脱敏失败! 请传递正确的参数 400 watermark.10000001 Unknown error 未知错误！ 请重试或联系技术支持。 400 watermark.10000002 Internal service error 内部错误！ 请重试或联系技术支持。 400 watermark.10000003 Failed to read the upload file 读取文件错误！ 请检查文件类型和大小 400 watermark.10000004 Invalid parameter 参数错误！ 请传递正确的参数 400 watermark.10000005 Watermark not found 该文件的水印未找到！ 请检查该文件是否加过水印。 400 watermark.10000006 File size exceeds maximum limit 上传文件超过最大限制！ 请检查文件的大小。 400 watermark.10000007 File format error 文件格式错误！ 请检查文件的格式。 400 watermark.10000008 Upload file is empty 上传文件为空！ 请检查文件内容是否为空。 400 watermark.10000009 Wrong password 密码错误！ 请检查文件的密码是否正确。 400 watermark.10000010 The ".doc" format file does not support the watermark feature currently .doc格式文件暂不支持水印功能！ 请检查文件的格式。 400 watermark.10000011 The ".xls" format file does not support the visible watermark feature currently .xls格式文件暂不支持明水印功能！ 请检查文件的格式。 400 watermark.10000012 The ".ppt" format file does not support the visible watermark feature currently .ppt格式文件暂不支持明水印功能！ 请检查文件的格式。 400 watermark.10000013 No watermark specified 没有指定水印内容！ 请检查水印参数是否传递。 400 watermark.10000014 There are many tasks at present. Please try again later 当前任务较多，请稍后再试！ 请重试或联系技术支持。 400 watermark.10000015 Blind watermark already exists 盲水印已经存在！ 请检查文件是否已存在盲水印。 400 watermark.10000016 There is not enough channel capacity to embed the watermark 文件解压后超过最大限制！ 请检查文件大小。 400 watermark.10000017 Image channel capacity is too small to embed watermark 图像信道容量过小，不能嵌入水印! 请重试或联系技术支持。 400 watermark.10000018 Currently does not support embedding watermark to image below 512 pixels 当前不支持给低于512像素的图片添加水印！ 请输入大于512像素的图片，或联系技术支持。 父主题： 附录

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求参数 表1 请求参数 参数 是否必选 参数类型 描述 algorithm 是 String 算法类型，PRESXY parameters 是 parameters Object 脱敏算法参数 表2 parameters 参数 是否必选 参数类型 描述 type 是 String 掩盖字符串的方式，取值为： CHAR：字符掩盖 RAND：随机掩盖 method 是 String 掩盖参数，若type字段为“RAND”时，method取值只能为： CHAR：替换为字母 DIGITAL：替换为数字 BOTH：数字与字母混合替换 x 是 Int 保留字符的开始位置 y 是 Int 保留字符的结束位置

请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "PRESXY", "parameters": { "type": "CHAR", "x": 1, "y": 1, "method": "*" } } ], "data": [ { "col1": "test" } ] } 或： { "mask_strategies": [ { "name": "col1", "algorithm": "PRESXY", "parameters": { "type": "RAND", "x": 1, "y": 1, "method": "CHAR" } } ], "data": [ { "col1": "test" } ] }

概述 欢迎使用 数据安全中心 服务（Data Security Center，DSC），数据安全中心服务（Data Security Center，DSC）是新一代的云化数据安全平台，提供数据分级分类、数据安全风险识别、数据水印溯源和数据静态脱敏等基础数据安全能力，通过资产地图整合数据安全生命周期各阶段状态，对外整体呈现云上数据安全态势。 您可以使用本文档提供的API对数据对进行相关操作，如数据库水印、图片水印、数据脱敏等。 在调用数据安全中心API之前，请确保已经充分了解数据安全中心相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 项目所在region的id，如：xx-xx-1。 src_file 是 String 待提取文字暗水印的图片地址，当前只支持OBS，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 mark_len 否 Integer 指定待提取水印的长度，最小0，最大32.。设置后可以提升水印提取性能。

状态码 状态码 编码 状态说明 200 OK 请求成功。 400 Bad Request 请求失败。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 请求认证失败。 表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 父主题： 附录

响应示例 状态码： 200 请求成功 { "marked_data" : [ { "item2" : 3, "item1" : "test" }, { "item2" : 5, "item1" : "test" } ] } 状态码： 400 参数错误 { "error_code" : "DSC.00000004", "error_msg" : "Invalid parameter" }

请求示例 嵌入内容为test12345678test的水印，水印密钥是keyword，字段类型列表中数据的字段名称为item1，该字段为主键。 POST https://{endpoit}/v1/{project_id}/sdg/database/watermark/embed { "watermark_content" : "test12345678test", "watermark_key" : "keyword", "columns" : [ { "name" : "item1", "type" : "INTEGER", "primary_key" : true }, { "name" : "item2", "type" : "INTEGER", "primary_key" : false } ], "data" : [ { "item1" : 0, "item2" : 3 }, { "item1" : 1, "item2" : 4 } ] }

响应示例 状态码： 200 请求成功 { "id" : "xxxxxx", "default_topic_urn" : "xxxxxx", "topic_count" : 1, "topics" : [ { "name" : "xxxxxx", "topic_urn" : "xxxxxx" } ] } 状态码： 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String DSC告警主题ID（非 消息通知 服务主题ID） default_topic_urn String 默认消息通知主题的唯一资源标识符 topic_count Integer 已确认的消息通知主题数量 topics Array of TopicBean objects 已确认的消息通知主题列表 表4 TopicBean 参数 参数类型 描述 name String 消息通知主题名称 topic_urn String 消息通知主题的唯一资源标识符 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 region_id String 当前项目所在region的id，如：xx-xx-1。 watermarked_file String 添加水印后的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://bucket/info/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求示例 给obs://bucket/info/wm.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。 POST /v1/{project_id}/doc-address/watermark/embed { "region_id" : "xx-xx-1", "src_file" : "obs://bucket/info/wm.doc", "doc_type" : "WORD", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 项目所在region的id，如：xx-xx-1。 src_file 是 String 待添加水印的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://bucket/info/wm.png，其中obs://表示OBS存储，bucket为桶名，info/wm.png为对象全路径名。 doc_type 是 String 待嵌入水印的文档类型。 枚举值： WORD EXCEL PDF PPT dst_file 否 String 添加水印后的文档存放地址，格式和要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 blind_watermark 否 String 暗文字水印内容，与“visible_watermark”字段至少有一个不为空 visible_watermark 否 String 明文字水印内容，与暗水印“blind_watermark”字段至少有一个不为空。 image_mark 否 String 待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段，图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB visible_type 否 String 该字段控制明水印嵌入文字还是图片。默认为TEXT类型，需填写visible_watermark字段设置明文字水印； 当该字段为IMAGE时，需填写image_watermark字段设置水印图片地址此时 ，“visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。 枚举值： TEXT IMAGE file_password 否 String 待加水印文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 marked_file_password 否 String 添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 readonly_password 否 String 添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 front 否 Integer 明水印字体大小，取值为[1,100]，默认值50 rotation 否 Integer 明水印旋转角度，逆时针方向，取值为[0,90]，默认值45。 opacity 否 Float 明水印的透明度，取值[0,1]，默认值为0.3；

请求参数 表1 请求参数 参数 是否必选 参数类型 描述 algorithm 是 String 算法类型，SYMBOL parameters 是 parameters Object 脱敏算法参数 表2 parameters 参数 是否必选 参数类型 描述 type 是 String 掩盖字符串的方式，取值为： CHAR：字符掩盖 RAND：随机掩盖 method 是 String 掩盖参数，若type字段为“RAND”时，method取值只能为： CHAR：替换为字母 DIGITAL：替换为数字 BOTH：数字与字母混合替换 direction 是 Int 掩盖的方向 0：特殊字符前掩盖 1：特殊字符后掩盖 symbol 是 String 指定的特殊字符

请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "SYMBOL", "parameters": { "type": "CHAR", "direction": 1, "symbol": "@", "method": "x" } } ], "data": [ { "col1": "test" } ] } 或： { "mask_strategies": [ { "name": "col1", "algorithm": "SYMBOL", //脱敏算法参数 "parameters": { "type": "RAND", "direction": 0, "symbol": "@", "method": "CHAR" } } ], "data": [ { "col1": "test" } ] }

请求示例 脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。 POST https://{endpoint}/v1/{project_id}/data/mask { "mask_strategies" : { "name" : "col", "algorithm" : "KEYWORD", "parameters" : { "key" : "keyword", "target" : "target" } }, "data" : { "col" : "keyword" } }

请求示例 修改xxxxxxxxxxxxxxxxxxx为通知主题，项目ID为xxxxxxxxxxxxxxxxxxx，告警通知状态为开启。 PUT /v1/{project_id}/sdg/smn/topic { "id" : "xxxxxxxxxxxxxxxxxxx", "project_id" : "xxxxxxxxxxxxxxxxxxx", "status" : 1, "topic_urn" : "xxxxxxxxxxxxxxxxxxx" }

请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": " NUMERIC", "parameters": { "value": 0.05 } } ], "data": [ { "col1": "test" } ] }

请求示例 提取数据水印，水印密钥是key，字段类型列表中数据的字段名称为col，该字段为非主键。 POST https://{endpoint}/v1/{project_id}/sdg/database/watermark/extract { "watermark_key" : "key", "columns" : { "name" : "col", "type" : "INTEGER", "primary_key" : false }, "data" : { "col" : 0.1 } }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用其进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 父主题： 使用前必读

min_by函数 查询y为最小值时对应的x值，或查询最小的n个y值对应的x值。 查询y为最小值时对应的x值。 语法：max_by(x, y) 查询最小的n个y值对应的x值。 语法：max_by(x, y, n) 表16 参数说明 参数名称 描述 类型 是否必选 x 原始字段。 任意数据类型 是 y 原始字段。 任意数据类型 是 n 大于0的整数。 int 否 返回值类型：与参数值的数据类型一致 示例1：统计请求时长最小时对应的请求方法。 表17 查询分析结果 类型 场景 查询语句 SELECT min_by(request_method, request_time) 返回结果 POST 示例2：统计请求时长最小的3个请求对应的请求方法。 表18 查询分析结果 类型 场景 查询语句 SELECT min_by(request_method, request_time, 3) 返回结果 ["POST","POST","POST"]

min函数 用于查询x中最小值。 查询x中最小的值。 语法：min(x) 查询x中最小的n个值，结果返回为数组。 语法： min(x, n) 表24 参数说明 参数名称 描述 类型 是否必选 x 原始字段。 任意数据 是 n 返回最小值的个数 正整数 否 返回值类型：与参数值的数据类型一致。 示例1：查询x中的最小值 表25 查询分析结果 类型 场景 查询语句 SELECT min(x) 返回结果 10.0 示例2：查询x中的最小的2个值 表26 查询分析结果 类型 场景 查询语句 SELECT min(x, 2) 返回结果 [10.0, 10.0]