获取规则组列表 - ListScanRuleGroups
功能介绍
功能介绍：获取规则组列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/server/scan/groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID。可参考获取项目ID获取。 约束限制： 不涉及 取值范围： 以IAM服务接口返回值为准，字符长度32-32。 默认取值： 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| category | 否 | String | 参数解释： 类别 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及 取值范围： IAM服务查询用户Token接口为准 默认取值： 不涉及 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| groups | Array of ResponseGroup objects | 参数解释： 分组 取值范围： 不涉及 |
| total | Integer | 参数解释： 总记录数 取值范围： 不涉及 |
| category | String | 参数解释： 类别 取值范围： 不涉及 |
| delete_allowed | Boolean | 参数解释： 是否允许删除 取值范围： true-是，false-否 |
| group_desc | String | 参数解释： 分组描述 取值范围： 不涉及 |
| group_name | String | 参数解释： 分组名称 取值范围： 不涉及 |
| id | String | 参数解释： 唯一标识 取值范围： 不涉及 |
| is_default | Boolean | 参数解释： 是否默认 取值范围： true-是，false-否 |
| rule_names | String | 参数解释： 规则名称列表 取值范围： 不涉及 |
| task_names | String | 参数解释： 任务名称列表 取值范围： 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释： 资源ID，唯一标识 取值范围： 不涉及 |
| group_name | String | 参数解释： 分组名称 取值范围： 不涉及 |
| group_desc | String | 参数解释： 分组描述 取值范围： 不涉及 |
| category | String | 参数解释： 类别 取值范围： |
| rule_names | String | 参数解释： 规则名称列表 取值范围： 不涉及 |
| task_names | String | 参数解释： 任务名称列表 取值范围： 不涉及 |
| delete_allowed | Boolean | 参数解释： 允许删除 取值范围： true-是，false-否 |
| is_default | Boolean | 参数解释： 是否默认工作空间 取值范围： true-是，false-否 |
请求示例
获取规则组列表
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/server/scan/groups
响应示例
状态码：200
{
"groups" : [ {
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"group_name" : "rule-group-01",
"group_desc" : "rule-group-01",
"category" : "BUILT_IN",
"rule_names" : "classification-rule-01",
"task_names" : "rule-group-01",
"delete_allowed" : true,
"is_default" : true
}, {
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"group_name" : "rule-group-01",
"group_desc" : "rule-group-01",
"category" : "BUILT_IN",
"rule_names" : "classification-rule-01",
"task_names" : "rule-group-01",
"delete_allowed" : true,
"is_default" : true
} ],
"total" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。
