Deleting a Geolocation Access Control Rule
Function
This API is used to delete a geolocation access control rule.
URI
DELETE /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 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. |
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. Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
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: CN: China, CA: Canada, US: The United States, AU: Australia, IN: India, JP: Japan, UK: United Kingdom, FR: France, DE: Germany, BR: Brazil, Thailand: Thailand, Singapore: Singapore,South Africa: South Africa, Mexico: Mexico, Peru: Peru, Indonesia: Indonesia |
white |
Integer |
Protective action
|
status |
Integer |
Rule status.
|
description |
String |
Description |
timestamp |
Long |
Time the rule is created. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Requests
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0
Example Responses
Status code: 200
Request succeeded.
{ "id" : "02dafa406c4941368a1037b020f15a53", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "timestamp" : 1650534513775, "description" : "demo", "status" : 1, "geoip" : "US", "white" : 0, "geoTagList" : [ "US" ] }
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