Updating a Geolocation Access Control Rule

Function

This API is used to update a geolocation access control rule.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to 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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header 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. Default: application/json;charset=utf8

**Table 4** Request body parameters
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) For details about the location code, see Appendix - Geographical Location Codes.
white	Yes	Integer	Protective action 0: WAF blocks requests that hit the rule. 1: WAF allows requests that hit the rule. 2: WAF only record requests that hit the rule.

Response Parameters

Status code: 200

**Table 5** Response body parameters
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) For details about the location code, see Appendix - Geographical Location Codes.
white	Integer	Protective action 0: WAF blocks requests that hit the rule. 1: WAF allows requests that hit the rule. 2: WAF only record requests that hit the rule.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

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.

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
}