创建防敏感信息泄露规则
功能介绍
创建防敏感信息泄露规则
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/policy/{policy_id}/antileakage
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
url |
是 |
String |
规则应用的url |
category |
是 |
String |
类别(响应码:code,敏感信息:sensitive) |
contents |
是 |
Array of strings |
规则内容(http状态码:400 、401、402 、 403 、404 、 405 、500 、501 、502 、503、 504 、507;手机:phone、身份证号:id_card、邮箱:email) |
action |
否 |
action object |
规则命中后操作对象 |
description |
否 |
String |
规则描述 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则id |
policyid |
String |
策略id |
url |
String |
规则应用的url |
category |
String |
类别 |
contents |
Array of strings |
内容 |
timestamp |
Long |
创建规则时间戳 |
status |
Integer |
规则状态,0:关闭,1:开启 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
在查询项目id为project_id,防护策略id为policy_id的防护策略下创建防敏感信息泄露规则。防敏感信息泄露规则的规则应用的url为"/attack",类别为敏感信息,规则内容为身份证号。
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage? { "url" : "/attack", "category" : "sensitive", "contents" : [ "id_card" ] }
响应示例
状态码: 200
请求成功
{ "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82", "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d", "timestamp" : 1668152426471, "status" : 1, "url" : "/attack", "category" : "sensitive", "contents" : [ "id_card" ] }
SDK代码示例
SDK代码示例如下。
在查询项目id为project_id,防护策略id为policy_id的防护策略下创建防敏感信息泄露规则。防敏感信息泄露规则的规则应用的url为"/attack",类别为敏感信息,规则内容为身份证号。
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 |
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.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateAntileakageRuleSolution { 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); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); CreateAntileakageRuleRequest request = new CreateAntileakageRuleRequest(); request.withPolicyId("{policy_id}"); CreateAntileakageRuleRequestBody body = new CreateAntileakageRuleRequestBody(); List<String> listbodyContents = new ArrayList<>(); listbodyContents.add("id_card"); body.withContents(listbodyContents); body.withCategory(CreateAntileakageRuleRequestBody.CategoryEnum.fromValue("sensitive")); body.withUrl("/attack"); request.withBody(body); try { CreateAntileakageRuleResponse response = client.createAntileakageRule(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()); } } } |
在查询项目id为project_id,防护策略id为policy_id的防护策略下创建防敏感信息泄露规则。防敏感信息泄露规则的规则应用的url为"/attack",类别为敏感信息,规则内容为身份证号。
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.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 = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAntileakageRuleRequest() request.policy_id = "{policy_id}" listContentsbody = [ "id_card" ] request.body = CreateAntileakageRuleRequestBody( contents=listContentsbody, category="sensitive", url="/attack" ) response = client.create_antileakage_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) |
在查询项目id为project_id,防护策略id为policy_id的防护策略下创建防敏感信息泄露规则。防敏感信息泄露规则的规则应用的url为"/attack",类别为敏感信息,规则内容为身份证号。
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateAntileakageRuleRequest{} request.PolicyId = "{policy_id}" var listContentsbody = []string{ "id_card", } request.Body = &model.CreateAntileakageRuleRequestBody{ Contents: listContentsbody, Category: model.GetCreateAntileakageRuleRequestBodyCategoryEnum().SENSITIVE, Url: "/attack", } response, err := client.CreateAntileakageRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。