文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别规则/ 获取规则组列表 - ListRuleGroups
更新时间:2026-10-20 GMT+08:00
分享

获取规则组列表 - ListRuleGroups

功能介绍

功能介绍:获取规则组列表,支持按类别过滤。 关键参数说明:category可选,按规则组类别过滤。 返回值说明:返回规则组总数及规则组列表(含规则名称、任务名称、是否可删除等)。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

category

否

String

参数解释:

规则组类别,用于按类别筛选规则组

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

groups

Array of ResponseBodyGroup objects

参数解释:

规则组列表,每个元素为一个ResponseBodyGroup对象,包含规则组的详细信息

取值范围:

数组类型

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

参数解释:

任务名称列表

取值范围:

不涉及

表5 ResponseBodyGroup

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

group_name

String

参数解释:

分组名称

取值范围:

不涉及

group_desc

String

参数解释:

分组描述

取值范围:

不涉及

category

String

参数解释:

类别

取值范围:

  • BUILT_IN-内置

  • BUILT_IN_COPY-内置复制

  • BUILT_SELF-自定义

rule_names

String

参数解释:

规则名称列表

取值范围:

不涉及

task_names

String

参数解释:

任务名称列表

取值范围:

不涉及

delete_allowed

Boolean

参数解释:

允许删除

取值范围:

true-是,false-否

is_default

Boolean

参数解释:

是否为默认规则组,标识该规则组是否为默认分组

取值范围:

true-是,false-否

请求示例

获取规则组列表

/v1/2b31ed520aabbccddeedb6e5712345678/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
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dsc.v1.region.DscRegion;
import com.huaweicloud.sdk.dsc.v1.*;
import com.huaweicloud.sdk.dsc.v1.model.*;


public class ListRuleGroupsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DscClient client = DscClient.newBuilder()
                .withCredential(auth)
                .withRegion(DscRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRuleGroupsRequest request = new ListRuleGroupsRequest();
        try {
            ListRuleGroupsResponse response = client.listRuleGroups(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdsc.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DscClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DscRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRuleGroupsRequest()
        response = client.list_rule_groups(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dsc.DscClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dsc.NewDscClient(hcClient)

    request := &model.ListRuleGroupsRequest{}
	response, err := client.ListRuleGroups(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档