文档首页/ 数据安全中心 DSC/ API参考（阿布扎比区域）/ API说明/ 敏感数据发现/ 查询扫描规则组列表
更新时间：2022-12-29 GMT+08:00
查看PDF
分享

查询扫描规则组列表

功能介绍

根据指定的项目ID查询扫描规则组列表

URI

GET /v1/{project_id}/sdg/server/scan/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

页码

limit

否

Integer

分页大小

请求参数

无

响应参数

状态码： 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

错误信息

请求示例

查询扫描规则组列表

GET /v1/{project_id}/sdg/server/scan/groups

响应示例

状态码： 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

请求成功

400

无效请求

错误码

请参见错误码。

父主题： 敏感数据发现