创建扫描规则组(待下线)
功能介绍
根据指定的规则组名称、描述、规则ID列表和分类创建敏感数据扫描规则组。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/sdg/server/scan/groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,用于标识具体的项目。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
否 |
String |
规则类别,用于区分内置规则(BUILT_IN)和用户自定义规则(BUILT_SELF)。 |
default_status |
否 |
Boolean |
是否默认规则组,表示该规则组是否为系统默认配置。 |
group_desc |
否 |
String |
规则组描述,对规则组功能的简要说明。 |
group_name |
否 |
String |
规则组名称,用于标识和管理规则组。 |
id |
否 |
String |
规则组ID,用于唯一标识该规则组。 |
rule_ids |
否 |
Array of strings |
包含的规则ID列表,用于指定该规则组下关联的所有扫描规则。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
msg |
String |
返回消息,用于描述操作结果或状态信息。 |
status |
String |
返回状态,表示操作是否成功,如'200'表示成功,'400'表示无效请求。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,用于唯一标识具体的错误类型。 |
error_msg |
String |
错误信息,对错误的详细描述。 |
请求示例
创建规则组名称为xxxx的自建扫描规则组。
POST /v1/{project_id}/sdg/server/scan/groups { "category" : "BUILT_SELF", "group_desc" : "xxxx", "group_name" : "xxxx", "rule_ids" : [ "xxxxxxxxxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxx" ] }
响应示例
状态码:200
请求成功,返回创建结果。
{ "msg" : "xxxx", "status" : "RESPONSE_SUCCESS" }
状态码:400
无效请求,参数格式或内容不符合要求。
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
SDK代码示例
SDK代码示例如下。
Java
创建规则组名称为xxxx的自建扫描规则组。
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 50 51 52 53 54 55 56 57 58 |
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.*; import java.util.List; import java.util.ArrayList; public class AddRuleGroupSolution { 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(); AddRuleGroupRequest request = new AddRuleGroupRequest(); RuleGroupRequest body = new RuleGroupRequest(); List<String> listbodyRuleIds = new ArrayList<>(); listbodyRuleIds.add("xxxxxxxxxxxxxxxxxxx"); listbodyRuleIds.add("xxxxxxxxxxxxxxxxxxx"); body.withRuleIds(listbodyRuleIds); body.withGroupName("xxxx"); body.withGroupDesc("xxxx"); body.withCategory(RuleGroupRequest.CategoryEnum.fromValue("BUILT_SELF")); request.withBody(body); try { AddRuleGroupResponse response = client.addRuleGroup(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
创建规则组名称为xxxx的自建扫描规则组。
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 |
# 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 = AddRuleGroupRequest() listRuleIdsbody = [ "xxxxxxxxxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxx" ] request.body = RuleGroupRequest( rule_ids=listRuleIdsbody, group_name="xxxx", group_desc="xxxx", category="BUILT_SELF" ) response = client.add_rule_group(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
创建规则组名称为xxxx的自建扫描规则组。
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 50 |
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.AddRuleGroupRequest{} var listRuleIdsbody = []string{ "xxxxxxxxxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxx", } groupNameRuleGroupRequest:= "xxxx" groupDescRuleGroupRequest:= "xxxx" categoryRuleGroupRequest:= model.GetRuleGroupRequestCategoryEnum().BUILT_SELF request.Body = &model.RuleGroupRequest{ RuleIds: &listRuleIdsbody, GroupName: &groupNameRuleGroupRequest, GroupDesc: &groupDescRuleGroupRequest, Category: &categoryRuleGroupRequest, } response, err := client.AddRuleGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功,返回创建结果。 |
400 |
无效请求,参数格式或内容不符合要求。 |
错误码
请参见错误码。