华为云用户手册

MRS 服务支持的组件 MRS 3.3.0-LTS.1支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,JobGateway,Guardian,Doris 流式集群包含的组件有：Kafka,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,Kafka,Flume,JobGateway,Guardian,Doris 自定义集群包含的组件有：CDL,Hadoop,Spark,HBase,Hive,Hue,IoTDB,Loader,Kafka,Flume,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,ClickHouse,Guardian,JobGateway,Doris MRS 3.2.0-LTS.1支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,Guardian 流式集群包含的组件有：Kafka,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,Kafka,Flume,Guardian 自定义集群包含的组件有：CDL,Hadoop,Spark2x,HBase,Hive,Hue,IoTDB,Loader,Kafka,Flume,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,ClickHouse,Guardian MRS 3.1.5支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,kudu,Sqoop,Guardian 流式集群包含的组件有：Kafka,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,kudu,Sqoop,Guardian,Kafka,Flume 自定义集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Kafka,Flume,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,ClickHouse,kudu,Sqoop,Guardian MRS 3.1.2-LTS.3支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez 流式集群包含的组件有：Kafka,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,Kafka,Flume 自定义集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Kafka,Flume,Flink,Oozie,ZooKeeper,HetuEngine,Ranger,Tez,ClickHouse MRS 3.1.0支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,Kudu 流式集群包含的组件有：Kafka,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,Kudu,Kafka,Flume 自定义集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Kafka,Flume,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,ClickHouse,Kudu MRS 3.0.5支持的组件信息如下： 分析集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,Kudu,Alluxio 流式集群包含的组件有：Kafka,Storm,Flume,ZooKeeper,Ranger 混合集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,Kudu,Alluxio,Kafka,Storm,Flume 自定义集群包含的组件有：Hadoop,Spark2x,HBase,Hive,Hue,Loader,Kafka,Storm,Flume,Flink,Oozie,ZooKeeper,Ranger,Tez,Impala,Presto,ClickHouse,Kudu,Alluxio MRS 2.1.0支持的组件信息如下： 分析集群包含的组件有：Presto,Hadoop,Spark,HBase,Hive,Hue,Loader,Tez,Flink,Impala,Kudu 流式集群包含的组件有：Kafka,Storm,Flume MRS 1.9.2支持的组件信息如下： 分析集群包含的组件有：Presto,Hadoop,Spark,HBase,Opentsdb,Hive,Hue,Loader,Tez,Flink,Alluxio,Ranger 流式集群包含的组件有：Kafka,KafkaManager,Storm,Flume

MRS支持的角色与组件对应表 表1 MRS支持的角色与组件对应表 角色名 组件名 OMS Server OMSServer NameNode HDFS Zkfc HDFS JournalNode HDFS DataNode HDFS ResourceManager Yarn NodeManager Yarn JobHistoryServer Mapreduce quorumpeer ZooKeeper HMaster HBase ThriftServer HBase RegionServer HBase SlapdServer LdapServer KerberosServer KrbServer KerberosAdmin KrbServer Hue Hue LoaderServer Loader JD BCS erver Spark JobHistory Spark SparkResource Spark JDB CS erver2x Spark2x JobHistory2x Spark2x SparkResource2x Spark2x MetaStore Hive WebHCat Hive HiveServer Hive MonitorServer Flume Flume Flume oozie Oozie KerberosClient KrbClient SlapdClient LdapClient meta meta DBServer DBService Broker Kafka Supervisor Storm Logviewer Storm Nimbus Storm UI Storm FlinkResource Flink ClickHouseServer ClickHouse ClickHouseBalancer ClickHouse HSBroker HetuEngine HSConsole HetuEngine QAS HetuEngine CDLConnector CDL CDLService CDL IoTDBServer IoTDB ConfigNode IoTDB FE Doris BE Doris DBroker Doris TokenServer Guardian JobServer JobGateway JobBalancer JobGateway 父主题： 附录

场景说明 如果您的网站“www.example.com”除了需要账号密码登录，还有其他的访问机制（例如，需要输入动态验证码），请您设置“cookie登录”方式进行 网站漏洞扫描 ，以便CodeArts Inspector能为您发现更多安全问题。 在添加域名并完成域名认证后，请您参照本文档对具有复杂访问机制的网站（“www.example.com”）进行 漏洞扫描 ，操作流程如下： ①获取网站的cookie值 → ②设置网站“cookie登录”方式 → ③创建扫描任务 → ④查看扫描结果并下载扫描报告

步骤3：创建扫描任务 创建扫描任务时，请您保持网站的登录状态，以免cookie失效。 在该域名所在行的“操作”列，单击“扫描”。 在“创建任务”界面，根据扫描需求，设置扫描参数，如图5所示。 关于扫描项的详细介绍，请参见创建扫描任务。 图5 创建扫描任务 设置完成后，单击“确认”，进入扫描任务页面。 创建扫描任务后，会先进入“排队中”状态，满足运行条件后任务状态变为“进行中”。 当网站列表中有“扫描状态”为“排队中”或“进行中”的任务时，可以单击网站列表上方的“批量取消”，在弹出的窗口中勾选需要取消扫描操作的网站进行批量取消。

步骤2：设置网站“cookie登录”方式 请参照以下操作步骤设置“cookie登录”方式。 登录管理控制台。 进入网站登录设置入口，如图3所示。 图3 进入网站登录设置入口 在弹出的“编辑”对话框中，将图2中网站的cookie值完整复制到“cookie值”文本框中，如图4所示。 图4 设置cookie登录方式 在“验证登录网址”文本框中输入用于验证登录的网址。 输入登录成功后才能访问的网址，便于漏洞管理服务快速判断您的登录信息是否有效。 单击“确认”，完成网站登录设置。

步骤4：查看扫描结果并下载扫描报告 扫描任务执行成功后，您可以查看扫描结果并下载扫描报告。 在目标网站所在行的“安全等级”列，单击“查看报告”，进入扫描任务详情页面，如图6所示。 图6 查看扫描任务详情 单击“生成报告”，弹出“生成报告配置”窗口。 扫描报告仅支持专业版及以上版本扫描任务下载，请升级到专业版及以上版本体验。 图7 生成扫描报告 生成的扫描报告会在24小时后过期。过期后，若需要下载扫描报告，请再次单击“生成报告”，重新生成扫描报告。 （可选）修改“报告名称”。 单击“确定”，弹出前往报告中心下载报告的提示框。 单击“确定”，进入“报告中心”页面。 单击生成报告所在行的“下载”，可将报告下载到本地。

查看扫描结果 在目标网站所在行的“安全等级”列，单击“查看报告”，进入扫描结果界面。 图6 查看报告 分别查看扫描项总览、漏洞列表、业务风险列表、端口列表、站点结构和站点信息。 图7 查看扫描结果 了解详细步骤请参考查看网站扫描详情。 单击“生成报告”，弹出“生成报告配置”窗口。 如果报告已生成，可直接执行8。扫描报告仅支持专业版及以上版本扫描任务下载，请升级到专业版及以上版本体验。 图8 生成报告 （可选）修改“报告名称”。 单击“确定”，弹出前往报告中心下载报告的提示框。 单击“确定”，进入“报告中心”页面。 单击生成报告所在行的“下载”，可将报告下载到本地。 单击“下载报告”，查看详细的检测报告。 基础版不支持下载报告功能，为了更好的防护您的资产，建议您购买专业版或者企业版漏洞管理服务。

漏洞管理服务权限 默认情况下，管理员创建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 漏洞管理服务部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问漏洞管理服务时，需要先切换至授权区域。 如表1所示，包括了漏洞管理服务的所有系统角色。由于华为云各服务之间存在业务交互关系，漏洞管理服务的角色依赖其他服务的角色实现功能。因此给用户授予漏洞管理服务的角色时，需要同时授予依赖的角色，漏洞管理服务的权限才能生效。 表1 漏洞管理服务系统角色 角色名称 描述 依赖关系 VSS Administrator 漏洞管理服务的管理员权限。 依赖Tenant Guest和Server Administrator角色。 Tenant Guest：全局级角色，在全局项目中勾选。 Server Administrator：项目级角色，在同项目中勾选。

响应示例 状态码： 200 请求成功 { "table_list" : [ { "id" : "xxxxxxxxxxxx", "name" : "xxxx", "path" : "xxxxxxxxxxxx", "risk_level" : 2, "type" : "MySQL" } ], "current_page" : 0, "total" : 1 } 状态码： 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 关系信息总数 current_page Integer 当前页 table_list Array of RelationSimpleInfo objects 关系信息列表 表4 RelationSimpleInfo 参数 参数类型 描述 id String 关系信息ID name String 关系信息名称 path String 关系信息路径 risk_level Integer 风险等级 type String 关系信息类型 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/dbs/{db_id}/tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID job_id 是 String 任务ID db_id 是 String 数据库ID 表2 Query参数 参数 是否必选 参数类型 描述 assets_name 否 String 资产名称 risk_start 是 Integer 起始风险等级 risk_end 是 Integer 终止风险等级 offset 是 Integer 偏移量 size 是 Integer 页面大小 limit 否 Integer 分页大小

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-4”，您可以从地区和终端节点获取，对应地区和终端节点页面的“区域”字段的值。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

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

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 FormData参数 参数 是否必选 参数类型 描述 doc_type 是 String 要嵌入水印的文档类型 枚举值： WORD EXCEL PDF PPT 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”字段无效。 枚举值： TEXT IMAGE

请求示例 通过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" }

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

请求示例 提取obs://hwbucket/hwinfo/hw.png路径下的图片中的图片暗水印，将提取的水印图片存放在obs://hwbucket/watermarkfile/mark.png路径下。 POST /v1/{project_id}/obs-image/image-watermark/extract HTTP/1.1 { "region_id" : "xx-xx-1", "src_file" : "obs://hwbucket/hwinfo/hw.png", "image_watermark" : "obs://hwbucket/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为对象全路径名。 image_watermark 是 String 提取出来的水印图片存放地址，格式要求同src_file。

响应示例 状态码： 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) 枚举值： BUILT_IN BUILT_SELF delete_allowed Boolean 是否允许删除 group_desc String 规则组描述 group_name String 规则组名称 id String 规则组ID rule_names String 规则名称 task_names String 扫描任务名称 is_default Boolean 是否为默认规则组 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 规则类别，内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值： 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) 枚举值： KEYWORD REGEX NLP

请求示例 创建规则名称为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" }

请求示例 在中国区域xxxxxxxxxxxx项目购买2个月的hws.service.type.sdg云服务实例，该产品支持XX个数据库或者obs的扫描量。 POST /v1/{project_id}/period/order { "charging_mode" : 0, "cloud_service_type" : "hws.service.type.sdg", "is_auto_renew" : 0, "period_num" : 1, "period_type" : 2, "region_id" : "xxxxxxxxxxxx", "zone" : "CH", "product_infos" : [ { "cloud_service_type" : "hws.service.type.sdg", "product_id" : "xxxxxxxxxxxx", "resource_size" : 30, "resource_size_measure_id" : 30, "resource_spec_code" : "base_professional", "resource_type" : "hws.resource.type.dsc.base" } ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 charging_mode 是 Integer 计费模式，0：包周期计费，1：按需计费，2：一次性计费 cloud_service_type 是 String 云服务类型 composite_product_id 否 String 组合套餐ID discount_id 否 String 折扣ID is_auto_renew 否 Integer 是否自动续费 period_num 是 Integer 订购周期数目 period_type 是 Integer 订购周期类型，2：月，3：年 product_infos 是 Array of ProductInfoBean objects 产品信息列表 promotion_activity_id 否 String 促销ID promotion_info 否 String 促销信息 region_id 是 String 当前项目所在region的id，如：xx-xx-1。 zone 是 String 所属国家区域 表3 ProductInfoBean 参数 是否必选 参数类型 描述 all_resource_names 否 Array of strings 资源名称列表 cloud_service_type 是 String 云服务类型 display_id 否 String 展示ID product_id 是 String 产品ID product_spec_desc 否 String 产品规格描述 resource_name 否 String 资源名称 resource_size 是 Integer 产品支持的数据库数量，或者支持obs的扫描量 resource_size_measure_id 是 Integer 资源容量度量标识，枚举值举例如下：15：mbps（购买带宽时使用），17：gb（购买云硬盘时使用），14：个/次 resource_spec_code 是 String 产品编码 resource_type 是 String 资源类型 usage_factor 否 String 已使用系数 usage_measure_id 否 Integer 已使用容量度量标识 usage_value 否 Double 已使用值

响应参数 状态码： 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 integers 风险数据行 表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 资产类型 枚举值： DATABASE OBS BIGDATA

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 规则类别，内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值： 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) 枚举值： KEYWORD REGEX NLP