Call the DeleteAddressBook API to delete an address book - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Operation description

This operation is used to delete an address book from access control.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DeleteAddressBook

delete

*AddressBook

acs:cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp `deprecated`	string	No	The source IP address of the request.	192.0.XX.XX
Lang	string	No	The language type. Valid values: en: English zh: Chinese (default). Valid values: en : English. zh : Chinese (default).	zh
GroupUuid	string	Yes	The unique ID of the address book. Note You can call the DescribeAddressBook operation to query the ID.	0657ab9d-fe8b-4174-b2a6-6baf358e****

In addition to the request parameters described in this topic, you must include the Alibaba Cloud API common request parameters when calling this operation. For more information about common parameters, see Common parameters. For the request format, see the request example in the Examples section of this topic.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	850A84D6-0DE4-4797-A1E8-00090125EEB1

Examples

Success response

JSON format

{
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125EEB1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorRecordLog	An error occurred while updating the operation log.	An error occurred while updating the operation log.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorAddressGroupReference	The address group is in use and cannot be deleted.	The address group is in use and cannot be deleted.
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorAddressGroupNotExist	The address group does not exist.	The address group does not exist.
401	ErrorAuthentication	An authentication error occurred.	An authentication error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.