华为云用户手册

响应示例 状态码：200 OK { "total" : 1, "tasks" : [ { "id" : "xxxxxxx", "name" : "ScanDemo", "cycle" : "ONCE", "status" : "FINISHED", "open" : true, "rule_groups" : [ "PCI" ], "last_run_time" : 1634612489173, "create_time" : 1630982438506, "last_scan_risk" : "HIGH", "use_nlp" : false, "topic_urn" : "", "start_time" : 1630983532673 } ] } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tasks Array of ScanJob objects 本次返回的扫描任务列表 total Long 任务总数 表4 ScanJob 参数 参数类型 描述 id String 任务ID name String 任务名称 rule_groups Array of strings 任务使用的规则组 cycle String 任务执行方式 status String 任务当前状态 last_run_time Long 任务上一次执行时间 create_time Long 任务创建时间 last_scan_risk String 任务上一次扫描风险等级结果 use_nlp Boolean 是否使用了NLP进行扫描 open Boolean 任务开启状态 topic_urn String SMN 服务通知主题 start_time Long 任务启动时间 security_level_name String 识别结果风险等级名称 security_level_color Long 识别结果风险等级 asset_infos Array of AssetInfo objects 资产列表 表5 AssetInfo 参数 参数类型 描述 asset_id String 资产ID asset_type String 资产类型 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID job_name String 任务名 type String 查询资产类型 db_scan_result DbScanResult object 数据库扫描结果 obs_scan_result ObsScanResult object OBS扫描结果 es_scan_result EsScanResult object ES扫描结果 表4 DbScanResult 参数 参数类型 描述 total Integer 扫描结果总数 db_scan_results Array of DbScanResultInfo objects 数据库扫描结果列表 表5 DbScanResultInfo 参数 参数类型 描述 task_id String 任务ID db_name String 数据库名称 table_id String 表ID table_name String 表名称 risk_level Integer 风险等级 sensitive_data_type Array of strings 匹配到的规则 match_info Array of DbMatchInfo objects 表中各列匹配到的规则 表6 DbMatchInfo 参数 参数类型 描述 column_name String 列名 rule_name String 匹配的规则名 rule_id String 匹配的规则ID rule_risk_level Integer 匹配规则风险等级 column_line Array of longs 风险数据行 表7 ObsScanResult 参数 参数类型 描述 total Integer 扫描结果总数 db_scan_results Array of ObsScanResultInfo objects OBS扫描结果列表 表8 ObsScanResultInfo 参数 参数类型 描述 task_id String 任务ID bucket_id String OBS桶ID bucket_name String OBS桶名称 file_path String 文件路径 file_name String 文件名 md5 String 文件md5值 risk_level Integer 风险等级 sensitive_data_type Array of strings 风险数据类型 表9 EsScanResult 参数 参数类型 描述 total Integer 扫描结果总数 db_scan_results Array of EsScanResultInfo objects ES扫描结果列表 表10 EsScanResultInfo 参数 参数类型 描述 task_id String 任务ID index_name String 索引名 type_id String 类型ID type_name String 类型名 risk_level Integer 风险等级 sensitive_data_type Array of strings 敏感数据类型 match_info Array of EsMatchInfo objects 规则匹配具体信息 表11 EsMatchInfo 参数 参数类型 描述 field_name String 数据字段名 rule_name String 规则名 rule_id String 规则ID rule_risk_level Integer 规则风险等级 状态码：400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码：200 OK { "job_id" : "xxxxxx", "job_name" : "xxxxxx", "type" : "DATABASE", "db_scan_result" : { "total" : 1, "db_scan_results" : [ { "task_id" : "xxxxxx", "db_name" : "xxxxxx", "table_id" : "xxxxxx", "table_name" : "student", "risk_level" : 6, "sensitive_data_type" : [ "xxxxxx", "xxxxxx" ], "match_info" : [ { "column_name" : "phone", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 6, "column_line" : [ 1, 3 ] }, { "column_name" : "email", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 1, "column_line" : [ 1, 3 ] } ] } ] }, "obs_scan_result" : null, "es_scan_result" : null } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

URI GET /v1/{project_id}/sdg/scan/job/{job_id}/results 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID job_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码 limit 否 Integer 分页大小 type 否 String 资产类型

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tasks Array of ScanJob objects 本次返回的扫描任务列表 total Long 任务总数 表4 ScanJob 参数 参数类型 描述 id String 任务ID name String 任务名称 rule_groups Array of strings 任务使用的规则组 cycle String 任务执行方式 status String 任务当前状态 last_run_time Long 任务上一次执行时间 create_time Long 任务创建时间 last_scan_risk String 任务上一次扫描风险等级结果 use_nlp Boolean 是否使用了NLP进行扫描 open Boolean 任务开启状态 topic_urn String SMN服务通知主题 start_time Long 任务启动时间 security_level_name String 识别结果风险等级名称 security_level_color Long 识别结果风险等级 asset_infos Array of AssetInfo objects 资产列表 表5 AssetInfo 参数 参数类型 描述 asset_id String 资产ID asset_type String 资产类型 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/{project_id}/sdg/scan/job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码 limit 否 Integer 分页大小 content 否 String 任务名称 is_new 否 Boolean 是否新版分级分类

响应示例 状态码：200 请求成功 { "total" : 1, "tasks" : [ { "id" : "xxxxxxxxxxxx", "name" : "xxxx", "cycle" : "xxxx", "status" : "FINISHED", "open" : true, "rule_groups" : [ "xxx" ], "scan_templates" : { "xxx" : "xxx" }, "last_run_time" : 1712904721162, "create_time" : 1712022723454, "last_scan_risk" : "HIGH", "use_nlp" : false, "topic_urn" : "", "start_time" : 0, "security_level_name" : "L4", "security_level_color" : 9, "asset_infos" : [ { "asset_id" : "xxx", "asset_type" : "obs" } ] } ] } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 rules Array of ResponseRule objects 规则列表 total Integer 规则总数 表4 ResponseRule 参数 参数类型 描述 category String 规则类别，内置规则(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) selected Boolean 是否可选 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码：200 请求成功 { "total" : 1, "rules" : [ { "category" : "BUILT_SELF", "delete_allowed" : true, "group_names" : "xxxx", "id" : "xxxxxxxxxxxx", "logic_operator" : "AND", "min_match" : 1, "risk_level" : 1, "rule_content" : "xxxx", "rule_desc" : "xxxx", "rule_name" : "xxxx", "rule_type" : "KEYWORD", "selected" : true } ] } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 调用API总次数 succeed Integer 调用API成功次数 failed Integer 调用API失败次数 openapi_called_records Array of OpenApiCalledRecord objects API调用记录列表 next_marker String 获取下一页所需的标识符。 表4 OpenApiCalledRecord 参数 参数类型 描述 user_name String 调用API的user_name user_id String 调用API的user_id domain_name String 调用API的domain_name domain_id String 调用API的domain_id request_url String 调用API的URL request_method String http请求方法 response_code String http状态码 fail_reason String 调用API失败原因 timestamp Long 调用API的时间（Unix timestamp），单位：毫秒 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/{project_id}/openapi/called-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页大小，默认1000，最大2000。 called_url 否 String 需要查询调用记录的URL，例如：/v1/{project_id}/sdg/database/watermark/embed start_time 否 Long 开始时间（Unix timestamp），单位：毫秒，例如：0 end_time 否 Long 结束时间（Unix timestamp），单位：毫秒，例如：1638515803572 marker 否 String 指定一个标识符。获取第一页时不用赋值，获取下一页时取上页查询结果的返回值。

响应示例 状态码：200 OK { "total" : 11, "succeed" : 11, "failed" : 0, "openapi_called_records" : [ { "user_name" : "xxxxxxxxxxxxx", "user_id" : "xxxxxxxxxxxxxxxxx", "domain_name" : "xxxxxxxxxxxxxxxxx", "domain_id" : "xxxxxxxxxxxxxxxxxxx", "request_url" : "/v1/xxxxxxxxxxxxxxxxxxxxxxxxxxx/sdg/doc/watermark/embed", "request_method" : "POST", "response_code" : "200", "fail_reason" : "", "timestamp" : 1638427576524 } ], "next_marker" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

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

请求参数 表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为对象全路径名。 image_watermark 是 String 提取出来的水印图片存放地址，格式要求同src_file。

请求示例 提取obs://bucket/info/wm.png路径下的图片中的图片暗水印，将提取的水印图片存放在obs://bucket/watermarkfile/mark.png路径下。 POST /v1/{project_id}/obs-image/image-watermark/extract HTTP/1.1 { "region_id" : "xx-xx-1", "src_file" : "obs://bucket/info/wm.png", "image_watermark" : "obs://bucket/watermarkfile/mark.png" }

请求参数 表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.。设置后可以提升水印提取性能。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 待提取暗水印的图片文件。 mark_len 否 String 指定待提取水印的长度，mark_len长度大于0，小于32。设置后可以提升水印提取性能

请求参数 表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 待提取水印的文档类型 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文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 FormData参数 参数 是否必选 参数类型 描述 doc_type 是 String 待提取水印的文档类型 file_password 否 String 解密文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 file 是 File 上传要提取水印的文档

请求示例 提取数据水印，水印密钥是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" : { "a" : 0.1 } } ] }

响应示例 状态码：200 请求成功 { "total" : 1, "groups" : [ { "id" : "xxxxxxxxxxxx", "group_name" : "xxxx", "group_desc" : "xxxx", "category" : "private", "rule_names" : "xxxx", "is_default" : false } ] } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 规则组总数 groups Array of ResponseGroup objects 规则组列表 表4 ResponseGroup 参数 参数类型 描述 category String 规则类别，内置规则(BUILT_IN)或自建规则(BUILT_SELF) delete_allowed Boolean 是否允许删除 group_desc String 规则组描述 group_name String 规则组名称 id String 规则组ID rule_names String 规则名称 task_names String 扫描任务名称 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID template_id 是 String 模板ID 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作区ID offset 否 Integer 页码 limit 否 Integer 分页大小

响应示例 状态码：200 OK { "tasks" : [ { "db_type" : "MySQL", "end_time" : 1658717568622, "execute_line" : 100000, "id" : "xxxxxxxxxxxx", "progress" : 100, "run_status" : "FINISHED", "start_time" : 1658717544469, "task_template_id" : "xxxxxxxxxxxx", "type" : "MANUAL" } ], "total" : 1 } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tasks Array of DBMaskTaskInfo objects 脱敏任务列表 total Integer 脱敏任务总数 表4 DBMaskTaskInfo 参数 参数类型 描述 db_type String DB类型 end_time Long 任务结束时间 execute_line Integer 执行行数 id String 任务ID progress Integer 执行进度 run_status String 任务运行状态 start_time Long 任务开始时间 task_template_id String 任务模板ID type String 任务类型 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 buckets Array of Bucket objects OBS桶列表 total Integer OBS桶总数 表4 Bucket 参数 参数类型 描述 asset_name String 资产名称 bucket_location String 桶位置 bucket_name String 桶名称 bucket_policy String 桶策略 create_time Long 创建时间 deleted Boolean 是否被删除 id String 桶ID is_deleted Boolean 是否被删除 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码：200 请求成功 { "buckets" : [ { "bucket_name" : "xxxx", "bucket_location" : "xxxx", "create_time" : 1667379757698, "is_deleted" : false } ], "total" : 1 } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 统计风险信息总数 security_level_list Array of ClassificationSecurityLevelInfo objects 统计风险信息列表 表4 ClassificationSecurityLevelInfo 参数 参数类型 描述 security_level_id String 风险等级ID security_level_name String 风险等级名称 security_level_color Integer 风险等级颜色 count Integer 风险对象个数 percent String 风险等级在统计信息中的百分比 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/{project_id}/scan-jobs/{job_id}/security-levels 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID job_id 是 String 敏感数据识别任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码 limit 否 Integer 分页大小 keyword 否 String 敏感信息对象名称关键字 asset_type 否 String 资源类型 asset_id 否 String 资产ID security_level_ids 否 Array of strings 风险等级ID数组 marker 否 Array of Object 上一批/下一批信息