增加自定义规则组 - AddRuleGroup
功能介绍
功能介绍:增加自定义规则组。 关键参数说明:group_name、group_desc、category、rule_ids必填。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/server/scan/groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 否 | String | 参数解释: 规则组资源ID,标识需要创建的规则组,若不传入该参数则由系统自动生成ID;若需指定,则传入合法格式的资源ID 约束限制: 不涉及 取值范围: 字符串类型,长度不超过1024个字符 默认取值: 不涉及 |
| group_name | 是 | String | 参数解释: 分组名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| group_desc | 是 | String | 参数解释: 分组描述 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| category | 是 | String | 参数解释: 类别 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| is_default | 否 | Boolean | 参数解释: 是否默认工作空间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| rule_ids | 是 | Array of strings | 参数解释: 规则ID列表,指定规则组中包含的规则,列表元素为字符串类型的规则ID,可通过调用查询规则列表接口获取 约束限制: 不涉及 取值范围: 数组类型 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
增加自定义规则组
{
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"group_name" : "rule-group-01",
"group_desc" : "rule-group-01",
"category" : "BUILT_IN",
"is_default" : true,
"rule_ids" : [ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e", "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b" ]
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "创建规则组成功",
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} 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 48 49 50 51 52 53 54 55 56 57 58 59 | 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("4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e"); listbodyRuleIds.add("7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b"); body.withRuleIds(listbodyRuleIds); body.withId("8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"); body.withGroupName("rule-group-01"); body.withGroupDesc("rule-group-01"); body.withCategory(RuleGroupRequest.RuleGroupRequest.fromValue("BUILT_IN")); 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
增加自定义规则组
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 | # 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 = [ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e", "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b" ] request.body = RuleGroupRequest( rule_ids=listRuleIdsbody, id="8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", group_name="rule-group-01", group_desc="rule-group-01", category="BUILT_IN" ) 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
增加自定义规则组
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 59 60 61 62 63 64 | 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.AddRuleGroupRequest{} var listRuleIdsbody = []string{ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e", "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b", } idRuleGroupRequest:= "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" groupNameRuleGroupRequest:= "rule-group-01" groupDescRuleGroupRequest:= "rule-group-01" categoryRuleGroupRequest:= model.GetRuleGroupRequestCategoryEnum().BUILT_IN request.Body = &model.RuleGroupRequest{ RuleIds: &listRuleIdsbody, Id: &idRuleGroupRequest, 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 | 请求已成功 |
错误码
请参见错误码。