Deleting ACL Rules in Batches¶
Function¶
This API is used to delete ACL rules in batches.
URI¶
DELETE /v1/{project_id}/acl-rule
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
fw_instance_id | No | String | Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. You can obtain the token by referring to Obtaining a User Token. |
Content-Type | Yes | String | Content type. It can only be set to application/json. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects). |
rule_ids | Yes | Array of strings | Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects). |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
data | Returned data for deleting ACL rules in batches. |
Parameter | Type | Description |
---|---|---|
responseDatas | Array of BatchDeleteRuleInfo objects | Data returned when rules are deleted in batches. |
Parameter | Type | Description |
---|---|---|
name | String | Names of the ACL rules to be deleted in batches. |
id | String | IDs of the ACL rules to be deleted in batches. |
Example Requests¶
Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
{
"rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ],
"object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}
Example Responses¶
Status code: 200
Return value for deleting rules in batches.
{
"data" : {
"responseDatas" : [ {
"name" : "test",
"id" : "0475c516-0e41-4caf-990b-0c504eebd73f"
}, {
"name" : "test2",
"id" : "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6"
} ]
}
}
Status Codes¶
Status Code | Description |
---|---|
200 | Return value for deleting rules in batches. |
Error Codes¶
See Error Codes.