文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 敏感数据发现/ 查询扫描规则组列表(待下线)
更新时间:2025-09-12 GMT+08:00
分享

查询扫描规则组列表(待下线)

功能介绍

根据指定的项目ID查询扫描规则组列表,返回规则组的总数和详细信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,用于标识具体的项目。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

页码,用于分页查询,默认值为0。

limit

Integer

分页大小,用于限制每页返回的结果数量,默认值为100。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

规则组总数,表示返回的规则组数量。

groups

Array of ResponseGroup objects

规则组列表,包含每个规则组的详细信息。

表4 ResponseGroup

参数

参数类型

描述

category

String

规则类别,用于区分内置规则(BUILT_IN)和用户自定义规则(BUILT_SELF)。

delete_allowed

Boolean

是否允许删除该规则组。

group_desc

String

规则组描述,对规则组功能的简要说明。

group_name

String

规则组名称,用于标识和管理规则组。

id

String

规则组ID,用于唯一标识该规则组。

rule_names

String

规则名称列表,表示该规则组下包含的所有规则名称。

task_names

String

扫描任务名称列表,表示与该规则组关联的所有扫描任务名称。

is_default

String

是否为默认规则组

状态码: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"
}

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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dsc.NewDscClient(
        dsc.DscClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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

请求成功,返回扫描规则组列表。

400

无效请求,参数格式或内容不符合要求。

错误码

请参见错误码

相关文档