获取规则组详情 - ShowGroupDetail
功能介绍
功能介绍:获取规则组的详细信息。 关键参数说明:通过group_id定位规则组。 返回值说明:返回规则组详情(含规则名称、任务名称、是否可删除等)。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/server/scan/groups/{group_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| group_id | 是 | String | 参数解释: 规则组ID,标识需要获取详情的规则组,可通过调用查询规则组列表接口获取,或可在数据安全中心控制台规则组页面查看 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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/2b31ed520aabbccddeedb6e5712345678/sdg/server/scan/groups/8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c
响应示例
状态码:200
{
"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
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。