Automate WAF Address Book Updates with API Calls - Web Application Firewall - Alibaba Cloud - Web Application Firewall

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-waf:AddAddress

update

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf_cdnsdf3****
RuleId	integer	Yes	The ID of the address book.	12345678
AddressList	array	Yes	The list of addresses to add.
	string	No	A single address. Supports IP addresses or IP CIDR blocks, and supports both IPv4 and IPv6.	XX.XX.XX.XX
ResourceManagerResourceGroupId	string	No	The Alibaba Cloud resource group ID.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2EFCFE18-78F8-5079-B312-07***48B

Examples

Success response

JSON format

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Defense.Control.DefenseAddressInvalid	The address in the address book is illegal.	The address in the address book is illegal.
400	Defense.Control.DefenseAddressOversize	The number of addresses in the address book exceeds the limit.	The number of addresses in the address book exceeds the limit.
400	Defense.Control.DefenseAddressOperationTooFrequent	Address book operations are too frequent.	Address book operations are too frequent. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.