华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 要添加水印的图片文件，添加的图片短边尺寸需要超过512像素。 blind_watermark 否 String 待嵌入的文字暗水印内容，长度不超过32个字符。当前仅支持数字及英文大小写。与图片暗水印image_watermark二选一填充。 image_watermark 否 File 待嵌入的图片暗水印文件，与文字暗水印 blind_watermark 二选一填充。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。

请求示例 通过form表单提交请求，其中file是具体文件。 POST /v1/{project_id}/sdg/doc/watermark/embed { "file" : "test.doc", "doc_type" : "WORD", "opacity" : "0.1", "font_size" : "30", "rotation" : "45", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 FormData参数 参数 是否必选 参数类型 描述 doc_type 是 String 要嵌入水印的文档类型 file_password 否 String 输入文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 marked_file_password 否 String 添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 readonly_password 否 String 添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 visible_watermark 否 String 明水印内容，与“blind_watermark”字段至少有一个不为空 font_size 否 String 明水印字体大小，取值为[1,100]，默认值50 rotation 否 String 明水印旋转角度，逆时针方向，取值为[0,90]，默认值45 opacity 否 String 明水印的透明度，取值[0,1]，默认值为0.3； blind_watermark 否 String 暗水印内容，与“visible_watermark”字段至少有一个不为空 file 是 File 要添加水印的文档 image_mark 否 File 图形水印的字节流。图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB；在分段的请求体“Content-Disposition”部分，参数“name”的值必须为“image_mark”。 visible_type 否 String 该字段为空时，默认为TEXT类型。 当该字段为IMAGE时: 请求的表单中必须包含名为“image”的图像文件，图像格式必须为“png”或“jpg”，否则返回参数错误； 图像文件大小不超过1MB； “visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。

响应示例 状态码：200 请求成功，返回分类结果列表。 { "classification_list" : [ { "id" : "xxxxxxxxxxxx", "project_id" : "xxxxxxxxxxxx", "job_id" : "xxxxxxxxxxxx", "task_id" : "xxxxxxxxxxxx", "ins_id" : "xxxxxxxxxxxx", "asset_id" : "xxxxxxxxxxxx", "asset_name" : "xxxxxxxxxxxx", "asset_type" : "OBS", "object_name" : "xxxxxxxxxxxx", "object_full_path" : "xxxxxxxxxxxx", "security_level_name" : "L4", "security_level_id" : "xxxxxxxxxxxx", "security_level_color" : 4, "create_time" : 1710560820120, "update_time" : 1710573345350, "scan_time" : 12293, "match_info" : [ { "template_id" : "xxxxxxxxxxxx", "template_name" : "xxxxxxxxxxxx", "rule_id" : "xxxxxxxxxxxx", "rule_name" : "xxxxx", "security_level_name" : "L4", "security_level_id" : "xxxxxxxxxxxx", "security_level_color" : 5, "classification_name" : "xxxxxxxxxxxx", "classification_id" : "xxxxxxxxxxxx", "matched_detail" : "xxx" } ] } ], "total" : 1, "marker" : [ { }, { } ] } 状态码：400 无效请求，参数格式或内容不符合要求。 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 识别结果总数，表示所有识别结果的总数。 classification_list Array of ClassificationResultsEntity objects 识别结果对象列表，包含每个识别结果的详细信息。 marker Array of objects 分批结果，用于分页查询时标识当前批次的结束位置。 表4 ClassificationResultsEntity 参数 参数类型 描述 id String 结果标记，用于唯一标识该识别结果。 project_id String 项目ID，用于标识具体的项目。 job_id String 任务ID，用于标识具体的任务。 task_id String 子任务ID，用于标识具体的子任务。 ins_id String 实例ID，用于标识具体的实例。 asset_id String 资产ID，用于标识具体的资产。 asset_name String 资产名称，用于标识和管理资产。 asset_type String 资产类型，表示资产的类型，如OBS、DATABASE、BIGDATA等。 object_name String 对象名称，表示资产中的具体对象名称。 object_full_path String 对象全路径，表示资产中对象的完整路径。 security_level_name String 识别结果等级名称，表示该资产的风险等级名称。 security_level_id String 识别结果等级ID，表示该资产的风险等级ID。 security_level_color Integer 识别结果等级颜色，用于在界面中显示风险等级的颜色标识。 create_time Long 创建时间，表示该识别结果的创建时间戳。 update_time Long 更新时间，表示该识别结果的最后更新时间戳。 scan_time Long 识别时间，表示该识别结果的开始识别时间。 match_info Array of ClassificationMatchInfo objects 匹配规则列表，表示该资产中所有匹配到的规则及其详细信息。 表5 ClassificationMatchInfo 参数 参数类型 描述 template_id String 识别模板ID，用于唯一标识该模板。 template_name String 识别模板名称，用于标识和管理模板。 rule_id String 规则ID，用于唯一标识该规则。 rule_name String 规则名称，用于标识和管理规则。 security_level_name String 识别结果等级名称，表示该规则识别出的风险等级名称。 security_level_id String 识别结果等级ID，表示该规则识别出的风险等级ID。 security_level_color Integer 识别结果等级颜色，用于在界面中显示风险等级的颜色标识。 classification_name String 分类分级名称，表示该规则所属的分类名称。 classification_id String 分类分级ID，表示该规则所属的分类ID。 matched_detail String 匹配明细，表示该规则匹配到的具体内容和位置。 matched_examples Array of MatchedExamples objects 匹配规则列表，表示该规则匹配到的具体内容示例。 表6 MatchedExamples 参数 参数类型 描述 line_number Long 行数，表示匹配内容在文件中的具体位置。 matched_content String 规则内容，表示匹配到的具体内容。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，用于唯一标识具体的错误类型。 error_msg String 错误信息，对错误的详细描述。

URI GET /v1/{project_id}/scan-jobs/{job_id}/classification-results 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，用于标识具体的项目。 job_id 是 String 敏感数据识别任务ID，用于标识具体的扫描任务。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码，用于分页查询，默认值为0。 limit 否 Integer 分页大小，用于限制每页返回的结果数量，默认值为100。 keyword 否 String 敏感信息对象名称关键字，用于模糊查询。 asset_type 否 String 资源类型，用于过滤结果。 asset_id 否 String 资产ID，用于过滤结果。 security_level_ids 否 Array of strings 风险等级ID数组，用于过滤结果。 marker 否 Array of strings 上一批/下一批信息，用于分页查询。

响应示例 状态码：200 请求成功，返回模板规则关联关系信息。 { "template_rules_list" : [ { "project_id" : "xxxxxxxxxxxx", "template_id" : "xxxxxxxxxxxx", "classification_id" : "xxxxxxxxxxxx", "security_level_id" : "xxxxxxxxxxxx", "security_level_name" : "L1", "security_level_color" : 1, "rule_id" : "xxxxxxxxxxxx", "rule_name" : "xxxxxxxxxxxx", "is_used" : true, "rule_description" : "xxxxxxxxxxxx" } ], "total" : 1 } 状态码：400 无效请求，参数格式或内容不符合要求。 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Long 规则总数，表示模板关联的规则数量。 template_rules_list Array of TemplateRule objects 规则列表，包含每个规则的详细信息。 表4 TemplateRule 参数 参数类型 描述 rule_id String 规则ID，用于唯一标识该规则。 project_id String 项目ID，用于标识具体的项目。 rule_name String 规则名称，用于标识和管理规则。 template_id String 模板ID，用于标识具体的扫描模板。 classification_id String 分级分类ID，表示该规则所属的分类。 security_level_id String 风险等级ID，表示该规则的风险等级。 security_level_name String 风险等级名称，表示该规则的风险等级的名称。 security_level_color Integer 风险等级颜色，用于在界面中显示风险等级的颜色标识。 is_used Boolean 是否启用，表示该规则是否被启用。 rule_description String 规则描述，对规则功能的简要说明。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，用于唯一标识具体的错误类型。 error_msg String 错误信息，对错误的详细描述。

URI GET /v1/{project_id}/scan-templates/{template_id}/scan-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，用于标识具体的项目。 template_id 是 String 模板ID，用于标识具体的扫描模板。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码，用于分页查询，默认值为0。 limit 否 Integer 分页大小，用于限制每页返回的结果数量，默认值为100。 keyword 否 String 敏感信息对象名称关键字，用于模糊查询。 classification_ids 否 Array of strings 分类ID数组，用于过滤结果。 security_level_ids 否 Array of strings 风险等级ID数组，用于过滤结果。 is_used 否 Boolean 是否启用，用于过滤结果。 rule_name 否 String 规则名称关键字，用于模糊查询。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应示例 状态码：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 扫描任务名称列表，表示与该规则组关联的所有扫描任务名称。 is_default String 是否为默认规则组 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，用于唯一标识具体的错误类型。 error_msg String 错误信息，对错误的详细描述。

URI GET /v1/{project_id}/sdg/server/scan/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，用于标识具体的项目。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码，用于分页查询，默认值为0。 limit 否 Integer 分页大小，用于限制每页返回的结果数量，默认值为100。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 msg String 返回消息，用于描述操作结果或状态信息。 status String 返回状态，表示操作是否成功，如'200'表示成功，'400'表示无效请求。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，用于唯一标识具体的错误类型。 error_msg String 错误信息，对错误的详细描述。

请求示例 创建规则名称为xxxx的自建规则，逻辑运算符选择AND，其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。 POST /v1/{project_id}/sdg/server/scan/rules { "category" : "BUILT_SELF", "logic_operator" : "AND", "min_match" : 1, "risk_level" : 1, "rule_content" : "xxxx", "rule_desc" : "xxxx", "rule_name" : "xxxx", "rule_type" : "KEYWORD" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 规则类别，用于区分内置规则（BUILT_IN）和用户自定义规则（BUILT_SELF）。 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）。

响应示例 状态码：200 请求成功 { "tasks" : [ { "id" : "xxxxxxxxxxxx", "category" : "OBS", "status" : "FINISHED", "progress" : 0, "asset_name" : "xxxx", "asset_id" : "xxxxxxxxxxxx", "start_time" : 1711960461182, "end_time" : 1711961941073, "scanned_object_num" : 4, "to_be_scanned_object_num" : 0, "scan_speed" : 1, "skip_object_num" : 15, "last_scan_risk" : "HIGH", "security_level_name" : "L4", "security_level_color" : 9 } ], "total" : 1 } 状态码：400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 子任务总数 tasks Array of ScanTask objects 子任务列表 表4 ScanTask 参数 参数类型 描述 id String 任务ID category String 资产类型 status String 任务状态 progress Integer 任务进度 asset_name String 资产名称 asset_id String 资产ID start_time Long 任务开始时间 end_time Long 任务结束时间 scanned_object_num Integer 已识别对象数 to_be_scanned_object_num Integer 待识别对象数 scan_speed Integer 扫描速率 skip_object_num Integer 跳过对象数 last_scan_risk String 上次识别结果 security_level_name String 识别结果 security_level_color Integer 识别结果等级 状态码：400 表5 响应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" }

响应参数 状态码：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 错误信息

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参数 参数 参数类型 描述 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" }

URI GET /v1/{project_id}/sdg/server/scan/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，用于标识具体的项目。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码，用于分页查询，默认值为0。 limit 否 Integer 分页大小，用于限制每页返回的结果数量，默认值为100。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 msg String 返回消息，用于描述操作的结果或错误信息。 status String 返回状态，如'200','400' 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，用于标识具体的错误类型。 error_msg String 错误信息，用于描述错误的具体内容。

响应示例 状态码：200 请求成功，返回安全等级列表。 { "security_level_list" : [ { "security_level_id" : "xxxxxxxxxxxx", "security_level_name" : "L4", "security_level_color" : 6, "count" : 2, "percent" : "0.2000" } ], "total" : 1 } 状态码：400 无效请求，参数格式或内容不符合要求。 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }