All Products
Search
Document Center

Cloud Firewall:DeleteAddressBook

Last Updated:Mar 19, 2024

Deletes an address book for access control.

Operation description

You can call the DeleteAddressBook operation to delete an address book for access control.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DeleteAddressBookWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.0.XX.XX
LangstringNo

The natural language of the request and response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
GroupUuidstringYes

The ID of the address book.

To delete the address book, you must provide the ID of the address book. You can call the DescribeAddressBook operation to query the ID.

0657ab9d-fe8b-4174-b2a6-6baf358e****

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the Examples section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

850A84D6-0DE4-4797-A1E8-00090125EEB1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ErrorRecordLogAn error occurred while updating the operation log.An error occurred while updating the operation log.
400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.
400ErrorAddressGroupReferenceThe address group is in use and cannot be deleted.The address group is in use and cannot be deleted.
400ErrorParametersUidThe aliUid parameter is invalid.The aliUid parameter is invalid.
401ErrorAuthenticationAn authentication error occurred.An authentication error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history