添加规则 - AddRule
功能介绍
功能介绍:添加识别规则。 关键参数说明:risk_level(1~10)、category、min_match(1~100)必填;非BUILT_IN类别时rule_name/rule_type/rule_content必填。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/server/scan/rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 否 | String | 参数解释: 规则资源ID,标识需要添加的识别规则,可通过调用查询规则列表接口获取该ID 约束限制: 不涉及 取值范围: 字符串类型,长度不超过1024个字符 默认取值: 不涉及 |
| rule_name | 是 | String | 参数解释: 规则名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| rule_type | 是 | String | 参数解释: 规则类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| logic_operator | 否 | String | 参数解释: 逻辑操作符 约束限制: 不涉及 取值范围: AND-且,OR-或 默认取值: 不涉及 |
| rule_content | 是 | String | 参数解释: 规则内容 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| risk_level | 是 | Integer | 参数解释: 规则等级 约束限制: 不涉及 取值范围: 1~10之间的整数 默认取值: 不涉及 |
| rule_desc | 否 | String | 参数解释: 规则描述 约束限制: 1-255字符 取值范围: 不涉及 默认取值: 不涉及 |
| category | 是 | String | 参数解释: 类别 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| min_match | 是 | Integer | 参数解释: 最小匹配 约束限制: 不涉及 取值范围: 1~100之间的整数 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
添加规则
{
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"rule_name" : "classification-rule-01",
"rule_type" : "KEYWORD",
"logic_operator" : "AND",
"rule_content" : "phone_number",
"risk_level" : 3,
"rule_desc" : "scan-rule-01",
"category" : "BUILT_IN",
"min_match" : 100
} 响应示例
状态码: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 | 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 AddRuleSolution { 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(); AddRuleRequest request = new AddRuleRequest(); RuleRequest body = new RuleRequest(); body.withRuleType(RuleRequest.RuleRequest.fromValue("KEYWORD")); body.withRuleName("classification-rule-01"); body.withRuleDesc("scan-rule-01"); body.withRuleContent("phone_number"); body.withRiskLevel(3); body.withMinMatch(100); body.withLogicOperator("AND"); body.withId("8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"); body.withCategory(RuleRequest.RuleRequest.fromValue("BUILT_IN")); request.withBody(body); try { AddRuleResponse response = client.addRule(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 = AddRuleRequest() request.body = RuleRequest( rule_type="KEYWORD", rule_name="classification-rule-01", rule_desc="scan-rule-01", rule_content="phone_number", risk_level=3, min_match=100, logic_operator="AND", id="8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", category="BUILT_IN" ) response = client.add_rule(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 | 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.AddRuleRequest{} ruleDescRuleRequest:= "scan-rule-01" idRuleRequest:= "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" request.Body = &model.RuleRequest{ RuleType: model.GetRuleRequestRuleTypeEnum().KEYWORD, RuleName: "classification-rule-01", RuleDesc: &ruleDescRuleRequest, RuleContent: "phone_number", RiskLevel: int32(3), MinMatch: int32(100), LogicOperator: "AND", Id: &idRuleRequest, Category: model.GetRuleRequestCategoryEnum().BUILT_IN, } response, err := client.AddRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。