Updating a Known Attack Source Rule
Function
This API is used to update a known attack source rule.
Constraints
This function is not supported in the ME-Abu Dhabi region.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/punishment/{rule_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range N/A Default Value N/A |
| policy_id | Yes | String | Definition Protection policy ID. You can call the ListPolicy API to obtain the policy ID. Constraints N/A Range N/A Default Value N/A |
| rule_id | Yes | String | Definition ID of an attack penalty rule. You can obtain the rule ID by calling the ListPunishmentRules API. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A |
| Content-Type | Yes | String | Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| category | Yes | String | Definition Type of the known attack source. Constraints The password cannot be changed. Range Default Value N/A |
| time_unit | No | String | Definition Time unit, which affects the value range of blocking time. Constraints N/A Range Default Value SECOND |
| block_time | Yes | Integer | Definition Blocking duration. Constraints The value range depends on the type of the known attack source and time unit. Range
N/A |
| description | No | String | Rule description. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Rule ID. |
| policyid | String | Policy ID. |
| block_time | Integer | Block duration. |
| time_unit | String | Time unit |
| category | String | Type of the known attack source rule. |
| description | String | Rule description. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
Update the attack penalty rule whose project ID is project_id, policy ID is policy_id, rule ID is rule_id, and attack penalty type is long_ip_block. Set the blocking duration to 1233 seconds and the rule description to update.
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/punishment/{rule_id}?
{
"category" : "long_ip_block",
"block_time" : "1233",
"time_unit" : "SECOND",
"description" : "update"
} Example Responses
Status code: 200
Request sent.
{
"block_time" : 1233,
"time_unit" : "SECOND",
"category" : "long_ip_block",
"description" : "update",
"id" : "2c3afdcc982b429da4f72ee483aece3e",
"policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d"
} SDK Sample Code
The SDK sample code is as follows.
Update the attack penalty rule whose project ID is project_id, policy ID is policy_id, rule ID is rule_id, and attack penalty type is long_ip_block. Set the blocking duration to 1233 seconds and the rule description to update.
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 | 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.*; public class UpdatePunishmentRuleSolution { 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(); UpdatePunishmentRuleRequest request = new UpdatePunishmentRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdatePunishmentRuleRequestBody body = new UpdatePunishmentRuleRequestBody(); body.withDescription("update"); body.withBlockTime(1233); body.withTimeUnit(UpdatePunishmentRuleRequestBody.TimeUnitEnum.fromValue("SECOND")); body.withCategory(UpdatePunishmentRuleRequestBody.CategoryEnum.fromValue("long_ip_block")); request.withBody(body); try { UpdatePunishmentRuleResponse response = client.updatePunishmentRule(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()); } } } |
Update the attack penalty rule whose project ID is project_id, policy ID is policy_id, rule ID is rule_id, and attack penalty type is long_ip_block. Set the blocking duration to 1233 seconds and the rule description to update.
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 | # 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 = UpdatePunishmentRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" request.body = UpdatePunishmentRuleRequestBody( description="update", block_time=1233, time_unit="SECOND", category="long_ip_block" ) response = client.update_punishment_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) |
Update the attack penalty rule whose project ID is project_id, policy ID is policy_id, rule ID is rule_id, and attack penalty type is long_ip_block. Set the blocking duration to 1233 seconds and the rule description to update.
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 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.UpdatePunishmentRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" descriptionUpdatePunishmentRuleRequestBody:= "update" timeUnitUpdatePunishmentRuleRequestBody:= model.GetUpdatePunishmentRuleRequestBodyTimeUnitEnum().SECOND request.Body = &model.UpdatePunishmentRuleRequestBody{ Description: &descriptionUpdatePunishmentRuleRequestBody, BlockTime: int32(1233), TimeUnit: &timeUnitUpdatePunishmentRuleRequestBody, Category: model.GetUpdatePunishmentRuleRequestBodyCategoryEnum().LONG_IP_BLOCK, } response, err := client.UpdatePunishmentRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Request sent. |
| 400 | Request failed. |
| 401 | The token does not have required permissions. |
| 500 | Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot