Updated on 2025-08-20 GMT+08:00

Creating a Geolocation Access Control Rule

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/geoip

Table 1 Path Parameters

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.

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.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Name of the geolocation access control rue.

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: Xizang, NM: Inner Mongolia)

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.

status

No

Integer

Rule status.

  • 1: enabled.

  • 0: disabled.

description

No

String

Rule description.

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.

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: Xizang, NM: Inner Mongolia)

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

Integer

Rule status.

  • 1: enabled.

  • 0: disabled.

timestamp

Long

Time the rule is created.

Status code: 400

Table 6 Response body parameters

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.

Table 7 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 8 Response body parameters

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.

Table 9 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 10 Response body parameters

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.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to create a geolocation access control rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The protective action is set to block, rule description to demo, rule name to demo, and blocked regions to Shanghai and Afghanistan.

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?enterprise_project_id=0

{
  "white" : 0,
  "description" : "demo",
  "name" : "demo",
  "geoip" : "SH|Afghanistan"
}

Example Responses

Status code: 200

OK

{
  "id" : "02dafa406c4941368a1037b020f15a53",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "timestamp" : 1650534513775,
  "status" : 1,
  "geoip" : "SH|Afghanistan",
  "white" : 0
}

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.