更新cc防护规则
功能介绍
更新cc防护规则
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
策略id(策略id从查询防护策略列表接口获取) |
rule_id |
是 |
String |
cc规则的ID。可以通过调用ListCcRules API获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
规则名称 |
mode |
是 |
Integer |
cc规则防护模式,对应console上的mode,现在只支持创建高级cc规则防护模式。
|
url |
否 |
String |
需要防护的域名路径,当cc防护规则为标准模式(mode参数值为0)时,该参数必填。 |
conditions |
是 |
Array of CcCondition objects |
cc规则防护规则限速条件,当cc防护规则为高级模式(mode参数值为1)时,该参数必填。 |
action |
是 |
action object |
请求次数限制到达后采取的防护动作 |
tag_type |
是 |
String |
限速模式:
|
tag_index |
否 |
String |
用户标识,当限速模式为用户限速(cookie或header)时,需要传该参数。
|
tag_condition |
否 |
tag_condition object |
用户标识,当限速模式为other时,需要传该参数。根据Referer(自定义请求访问的来源)字段区分单个Web访问者 |
limit_num |
是 |
Integer |
限制频率,单位为次,范围为1~2147483647 |
limit_period |
是 |
Integer |
限速周期,单位为秒,范围1~3600 |
unlock_num |
否 |
Integer |
放行频率,单位为次,范围为0~2147483647。只有当防护动作类型为dynamic_block时,才需要传该参数。 |
lock_time |
否 |
Integer |
阻断时间,单位为秒,范围为0~65535。当“防护动作”选择“阻断”时,可设置阻断后恢复正常访问页面的时间。 |
domain_aggregation |
否 |
Boolean |
是否开启域名聚合统计。 |
region_aggregation |
否 |
Boolean |
是否开启全局计数。 |
description |
否 |
String |
规则描述 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
是 |
String |
字段类型 |
logic_operation |
是 |
String |
条件列表匹配逻辑。
|
contents |
否 |
Array of strings |
条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时,需要传该参数。 |
value_list_id |
否 |
String |
引用表id。当logic_operation参数以any或者all结尾时,需要传该参数。此外,引用表类型要与category类型保持一致。 |
index |
否 |
String |
子字段,当字段类型(category)选择“params”、“cookie”、“header”时,请根据实际需求配置子字段且该参数必填。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
是 |
String |
动作类型:
|
detail |
否 |
detail object |
阻断页面信息。当防护动作(category)选择阻断(block)或者动态阻断(dynamic_block)时,需要设置返回的阻断页面。
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
规则名称 |
id |
String |
Rule ID. |
policyid |
String |
Policy ID. |
url |
String |
当mode值为0时,该参数有返回值。规则应用的URL链接,不包含域名。 |
prefix |
Boolean |
路径是否为前缀模式,当防护url以*结束,则为前缀模式。 |
mode |
Integer |
cc规则防护模式,对应console上的mode,现在只支持创建高级cc规则防护模式。
|
conditions |
Array of CcCondition objects |
cc规则防护规则限速条件,当cc防护规则为高级模式(mode参数值为1)时,该参数必填。 |
action |
action object |
请求次数限制到达后采取的防护动作 |
tag_type |
String |
限速模式:
|
tag_index |
String |
用户标识,当限速模式为用户限速(cookie或header)时,需要传该参数。
|
tag_condition |
tag_condition object |
用户标识,当限速模式为other时,需要传该参数。根据Referer(自定义请求访问的来源)字段区分单个Web访问者 |
limit_num |
Integer |
限制频率,单位为次,范围为1~2147483647 |
limit_period |
Integer |
限速周期,单位为秒,范围1~3600 |
unlock_num |
Integer |
放行频率,单位为次,范围为0~2147483647。只有当防护动作类型为dynamic_block时,才需要传该参数。 |
lock_time |
Integer |
阻断时间,单位为秒,范围为0~65535。当“防护动作”选择“阻断”时,可设置阻断后恢复正常访问页面的时间。 |
domain_aggregation |
Boolean |
是否开启域名聚合统计。 |
region_aggregation |
Boolean |
是否开启全局计数。 |
description |
String |
规则描述 |
total_num |
Integer |
该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数 |
unaggregation |
Boolean |
该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数 |
aging_time |
Integer |
规则老化时间,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数 |
producer |
Integer |
规则创建对象,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
字段类型 |
logic_operation |
String |
条件列表匹配逻辑。
|
contents |
Array of strings |
条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时,需要传该参数。 |
value_list_id |
String |
引用表id。当logic_operation参数以any或者all结尾时,需要传该参数。此外,引用表类型要与category类型保持一致。 |
index |
String |
子字段,当字段类型(category)选择“params”、“cookie”、“header”时,请根据实际需求配置子字段且该参数必填。 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
动作类型:
|
detail |
detail object |
阻断页面信息。当防护动作(category)选择阻断(block)或者动态阻断(dynamic_block)时,需要设置返回的阻断页面。
|
参数 |
参数类型 |
描述 |
---|---|---|
content_type |
String |
内容类型,值可为“application/json”、“text/html”、“text/xml”。 |
content |
String |
阻断页面内容 |
状态码: 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,规则id为rule_id的cc规则,修改限速模式为ip限速,限速频率为10次,限速周期为60秒,请求次数限制到达后采取的防护动作为人机验证,cc规则防护模式为高级,规则的名称为test55,不开启域名聚合统计,cc规则防护规则限速条件是URL包含“/url”,没有子字段,不开启全局计数。
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}? { "description" : "", "tag_type" : "ip", "limit_num" : 10, "limit_period" : 60, "action" : { "category" : "captcha" }, "mode" : 1, "name" : "test55", "domain_aggregation" : false, "conditions" : [ { "category" : "url", "logic_operation" : "contain", "contents" : [ "/url" ], "index" : null } ], "region_aggregation" : false }
响应示例
状态码: 200
Request succeeded.
{ "id" : "f88c5eabff9b4ff9ba6e7dd8e38128ba", "policyid" : "d471eef691684f1c8d7784532fd8f4bd", "name" : "test55", "description" : "", "mode" : 1, "conditions" : [ { "category" : "url", "contents" : [ "/url" ], "logic_operation" : "contain" } ], "action" : { "category" : "captcha" }, "producer" : 1, "unaggregation" : false, "total_num" : 0, "limit_num" : 10, "limit_period" : 60, "lock_time" : 0, "tag_type" : "ip", "aging_time" : 0, "region_aggregation" : false, "domain_aggregation" : false }
SDK代码示例
SDK代码示例如下。
修改项目id为project_id,防护策略id为policy_id,规则id为rule_id的cc规则,修改限速模式为ip限速,限速频率为10次,限速周期为60秒,请求次数限制到达后采取的防护动作为人机验证,cc规则防护模式为高级,规则的名称为test55,不开启域名聚合统计,cc规则防护规则限速条件是URL包含“/url”,没有子字段,不开启全局计数。
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 65 66 67 68 69 70 71 72 73 74 |
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 UpdateCcRuleSolution { 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(); UpdateCcRuleRequest request = new UpdateCcRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdateCcRuleRequestBody body = new UpdateCcRuleRequestBody(); CreateCcRuleRequestBodyAction actionbody = new CreateCcRuleRequestBodyAction(); actionbody.withCategory(CreateCcRuleRequestBodyAction.CategoryEnum.fromValue("captcha")); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("/url"); List<CcCondition> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CcCondition() .withCategory(CcCondition.CategoryEnum.fromValue("url")) .withLogicOperation("contain") .withContents(listConditionsContents) ); body.withDescription(""); body.withRegionAggregation(false); body.withDomainAggregation(false); body.withLimitPeriod(60); body.withLimitNum(10); body.withTagType(UpdateCcRuleRequestBody.TagTypeEnum.fromValue("ip")); body.withAction(actionbody); body.withConditions(listbodyConditions); body.withMode(1); body.withName("test55"); request.withBody(body); try { UpdateCcRuleResponse response = client.updateCcRule(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,规则id为rule_id的cc规则,修改限速模式为ip限速,限速频率为10次,限速周期为60秒,请求次数限制到达后采取的防护动作为人机验证,cc规则防护模式为高级,规则的名称为test55,不开启域名聚合统计,cc规则防护规则限速条件是URL包含“/url”,没有子字段,不开启全局计数。
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 |
# 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 = UpdateCcRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" actionbody = CreateCcRuleRequestBodyAction( category="captcha" ) listContentsConditions = [ "/url" ] listConditionsbody = [ CcCondition( category="url", logic_operation="contain", contents=listContentsConditions ) ] request.body = UpdateCcRuleRequestBody( description="", region_aggregation=False, domain_aggregation=False, limit_period=60, limit_num=10, tag_type="ip", action=actionbody, conditions=listConditionsbody, mode=1, name="test55" ) response = client.update_cc_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,规则id为rule_id的cc规则,修改限速模式为ip限速,限速频率为10次,限速周期为60秒,请求次数限制到达后采取的防护动作为人机验证,cc规则防护模式为高级,规则的名称为test55,不开启域名聚合统计,cc规则防护规则限速条件是URL包含“/url”,没有子字段,不开启全局计数。
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 65 66 67 68 |
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.UpdateCcRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" actionbody := &model.CreateCcRuleRequestBodyAction{ Category: model.GetCreateCcRuleRequestBodyActionCategoryEnum().CAPTCHA, } var listContentsConditions = []string{ "/url", } var listConditionsbody = []model.CcCondition{ { Category: model.GetCcConditionCategoryEnum().URL, LogicOperation: "contain", Contents: &listContentsConditions, }, } descriptionUpdateCcRuleRequestBody:= "" regionAggregationUpdateCcRuleRequestBody:= false domainAggregationUpdateCcRuleRequestBody:= false nameUpdateCcRuleRequestBody:= "test55" request.Body = &model.UpdateCcRuleRequestBody{ Description: &descriptionUpdateCcRuleRequestBody, RegionAggregation: ®ionAggregationUpdateCcRuleRequestBody, DomainAggregation: &domainAggregationUpdateCcRuleRequestBody, LimitPeriod: int32(60), LimitNum: int32(10), TagType: model.GetUpdateCcRuleRequestBodyTagTypeEnum().IP, Action: actionbody, Conditions: listConditionsbody, Mode: int32(1), Name: &nameUpdateCcRuleRequestBody, } response, err := client.UpdateCcRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Request succeeded. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
错误码
请参见错误码。