Li, Qiao 901ea67b42 waf dedicated API 01

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>

2022-12-08 14:03:35 +00:00

17 KiB

Raw Blame History

Creating a Geolocation Access Control Rule

Function

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

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
policy_id	Yes	String	Policy ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
Content-Type	Yes	String	Content type Default: application/json;charset=utf8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
geoip	Yes	String	Applicable regions. The value can be the region code. CA: Canada US: USA AU: Australia IN: India JP: Japan UK: United Kingdom FR: France DE: Germany BR: Brazil Ukraine: Ukraine Pakistan: Pakistan Palestine: Palestine Israel: Israel Iraq: Afghanistan Libya: Libya Turkey: Turkey Thailand: Thailand Singapore: Singapore South Africa: South Africa Mexico: Mexico Peru: Peru
white	Yes	Integer	Protective action. The value can be: 0: WAF blocks the requests that hit the rule. 1: WAF allows the requests that hit the rule. 2: WAF only logs the requests that hit the rule.
description	No	String	Rule description

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Rule ID.
policyid	String	Policy ID
geoip	String	Applicable regions. The value can be the region code. CA: Canada US: USA AU: Australia IN: India JP: Japan UK: United Kingdom FR: France DE: Germany BR: Brazil Ukraine: Ukraine Pakistan: Pakistan Palestine: Palestine Israel: Israel Iraq: Afghanistan Libya: Libya Turkey: Turkey Thailand: Thailand Singapore: Singapore South Africa: South Africa Mexico: Mexico Peru: Peru
white	Integer	Protective action. The value can be: 0: WAF blocks the requests that hit the rule. 1: WAF allows the requests that hit the rule. 2: WAF only logs the requests that hit the rule.
status	Integer	Rule status. The value can be: 0: The rule is disabled. 1: The rule is enabled.
timestamp	Long	Time the rule is created. The value is a 13-digit timestamp in ms.
description	String	Rule description

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

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

{
  "white" : 0,
  "description" : "demo",
  "geoip" : "BR"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "02dafa406c4941368a1037b020f15a53",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "timestamp" : 1650534513775,
  "description" : "demo",
  "status" : 1,
  "geoip" : "BR",
  "white" : 0,
  "geoTagList" : [ "SH", "Afghanistan" ]
}

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.

Parent topic: Rule Management

17 KiB Raw Blame History