Updating a Geolocation Access Control Rule
Function
This API is used to update a geolocation access control rule.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API (value of the id field in the response body). |
rule_id |
Yes |
String |
ID of the geolocation access control rule. You can obtain the rule ID by calling ListGeoipRule API which is used to query the list of geolocation access control rules. The rule ID is included the id field in the response body. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Name of the geolocation access control rue. |
description |
No |
String |
Description. |
geoip |
Yes |
String |
Locations that can be configured in the geolocation access control rule: (Countries/Regions outside China: CA: Canada, South Africa: South Africa, Mexico: Mexico, Peru: Peru, Indonesia: Indonesia Cities inside China: GD: Guangdong, FJ: Fujian, JL: Jilin, LN: Liaoning, TW: Taiwan (China), GZ: Guizhou, AH: Anhui, HL: Heilongjiang, HA: Henan, SC: Sichuan, HE: Hebei, YN: Yunnan, HB: Hubei, HI: Hainan, QH: Qinghai, HN: Hunan, JX: Jiangxi, SX: Shanxi, SN: Shaanxi, ZJ: Zhejiang, GS: Gansu, JS: Jiangsu, SD: Shandong, BJ: Beijing, SH: Shanghai, TJ: Tianjin, CQ: Chongqing, MO: Macao (China), HK: Hong Kong (China), NX: Ningxia, GX: Guangxi, XJ: Xinjiang, XZ: Tibet, NM: Inner Mongolia) For details about the location code, see Appendix - Geographical Location Codes. |
white |
Yes |
Integer |
Protective action
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
name |
String |
Name of the geolocation access control rue. |
description |
String |
Description. |
policyid |
String |
Policy ID. |
geoip |
String |
Locations that can be configured in the geolocation access control rule: (Countries/Regions outside China: CA: Canada, South Africa: South Africa, Mexico: Mexico, Peru: Peru, Indonesia: Indonesia Cities inside China: GD: Guangdong, FJ: Fujian, JL: Jilin, LN: Liaoning, TW: Taiwan (China), GZ: Guizhou, AH: Anhui, HL: Heilongjiang, HA: Henan, SC: Sichuan, HE: Hebei, YN: Yunnan, HB: Hubei, HI: Hainan, QH: Qinghai, HN: Hunan, JX: Jiangxi, SX: Shanxi, SN: Shaanxi, ZJ: Zhejiang, GS: Gansu, JS: Jiangsu, SD: Shandong, BJ: Beijing, SH: Shanghai, TJ: Tianjin, CQ: Chongqing, MO: Macao (China), HK: Hong Kong (China), NX: Ningxia, GX: Guangxi, XJ: Xinjiang, XZ: Tibet, NM: Inner Mongolia) For details about the location code, see Appendix - Geographical Location Codes. |
white |
Integer |
Protective action
|
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
The following example shows how to update a geolocation access control rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The protective action is set to block, rule description to demo, rule name to demo, and blocked regions to Beijing and Afghanistan.
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0 { "white" : 0, "name" : "demo", "geoip" : "BJ|Afghanistan" }
Example Responses
Status code: 200
Request succeeded.
{ "id" : "02dafa406c4941368a1037b020f15a53", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "description" : "demo", "geoip" : "BJ|Afghanistan", "white" : 0 }
SDK Sample Code
The SDK sample code is as follows.
The following example shows how to update a geolocation access control rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The protective action is set to block, rule description to demo, rule name to demo, and blocked regions to Beijing and Afghanistan.
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 |
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 UpdateGeoipRuleSolution { 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(); UpdateGeoipRuleRequest request = new UpdateGeoipRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdateGeoipRuleRequestBody body = new UpdateGeoipRuleRequestBody(); body.withWhite(0); body.withGeoip("BJ|Afghanistan"); body.withName("demo"); request.withBody(body); try { UpdateGeoipRuleResponse response = client.updateGeoipRule(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()); } } } |
The following example shows how to update a geolocation access control rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The protective action is set to block, rule description to demo, rule name to demo, and blocked regions to Beijing and Afghanistan.
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 |
# 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 = UpdateGeoipRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" request.body = UpdateGeoipRuleRequestBody( white=0, geoip="BJ|Afghanistan", name="demo" ) response = client.update_geoip_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) |
The following example shows how to update a geolocation access control rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The protective action is set to block, rule description to demo, rule name to demo, and blocked regions to Beijing and Afghanistan.
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 |
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.UpdateGeoipRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" nameUpdateGeoipRuleRequestBody:= "demo" request.Body = &model.UpdateGeoipRuleRequestBody{ White: int32(0), Geoip: "BJ|Afghanistan", Name: &nameUpdateGeoipRuleRequestBody, } response, err := client.UpdateGeoipRule(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 succeeded. |
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