ModifyAddressBook API reference - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Modifies an address book.

Operation description

This operation is used to modify an address book.

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:ModifyAddressBook

update

*AddressBook

acs:yundun-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
AddressList	string	No	The addresses in the address book. Separate multiple addresses with commas (,). Use a space to separate an address from its description. This parameter is required when GroupType is set to ip, port, or domain. When GroupType is set to ip, specify IP addresses. Example: 1.2.XX.XX/32 Development CIDR block,10.0.0.X/24,1.2.XX.XX/24 Test CIDR block. When GroupType is set to port, specify ports or port ranges. Example: 80/80 HTTP port,100/200,3306 Database port. When GroupType is set to domain, specify domain names. Example: demo1.aliyun.com Test domain name,demo2.aliyun.com,www.aliyun.com Alibaba Cloud official website.	192.0.XX.XX/32 ,192.0.XX.XX/24
Description	string	Yes	The description of the address book.	bj-001
GroupName	string	Yes	The name of the address book.	bj-001
GroupUuid	string	Yes	The unique ID of the address book. Note You can obtain the value by calling the DescribeAddressBook operation.	0657ab9d-fe8b-4174-b2a6-6baf358e****
AutoAddTagEcs	string	No	Specifies whether the public IP addresses of Elastic Compute Service (ECS) instances that match new labels is automatically added to the address book. Valid values: 0 : Do not automatically add. 1 : Automatically add.	1
TagRelation	string	No	The logical relationship among multiple ECS tags. Valid values: or: The public IP address of an ECS instance is added to the address book if the instance matches any of the specified tags. and: The public IP address of an ECS instance is added to the address book only if the instance matches all of the specified tags. Valid values: or : The relationship among multiple labels is OR. The public IP addresses of Elastic Compute Service (ECS) instances that match any of the specified labels are added to the address book. and : The relationship among multiple labels is AND. The public IP addresses of Elastic Compute Service (ECS) instances that match all of the specified labels are added to the address book.	and
TagList	array<object>	No	The ECS tag list.
	object	No	The ECS tag.
TagValue	string	No	The value of the ECS tag.	1
TagKey	string	No	The key of the ECS tag.	TXY
ModifyMode	string	No	The modification mode. Note When GroupType is set to ip, ipv6, port, or domain, the default value is Cover if this parameter is not specified. Important When GroupType is set to tag, this parameter must be left empty. Valid values: Delete : Deletes the addresses specified by the AddressList parameter from the address book. Cover : Overwrites the address book with the addresses specified by the AddressList parameter. Append : Appends the addresses specified by the AddressList parameter to the address book.	Cover
AckNamespaces	array	No	The list of namespaces for ACK cluster pods. Note A maximum of 10 namespaces are supported.
	string	No	The namespace for ACK cluster pods. You can obtain the value by calling the following operation: DescribeAckClusterNamespaces: queries ACK cluster namespaces. Note This parameter is required when GroupType is set to ackNamespace.	default
AckLabels	array<object>	No	The list of labels for ACK cluster pods. Note A maximum of 10 labels are supported.
	object	No	The label for ACK cluster pods. You can obtain the value by calling the following operation: DescribeAckClusterPodLabels: queries ACK cluster pod labels. Note This parameter is required when GroupType is set to ackLabel.
Key	string	No	The key of the ACK cluster pod label.	app
Value	string	No	The value of the ACK cluster pod label.	storage-operator
		No	The list of member accounts for the asset address book.
		No	The list of regions and resource types for the asset address book.

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

Examples

Success response

JSON format

{
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorAddressCountExceed	The maximum number of addresses is exceeded.	The maximum number of address is exceeded.
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.	The IP address of the address group is invalid.
400	ErrorParamDomain	The parameter Domain is invalid.	The parameter Domain is invalid.
400	ErrorAddressGroupNotExist	The address group does not exist.	The address group does not exist.
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.	An error occurred while performing an insert operation in the database.
400	ErrorRecordLog	An error occurred while updating the operation log.	An error occurred while updating the operation log.
400	ErrorParametersGroupPort	The group port is invalid.	The group port is invalid.
400	ErrorAclExtendedCountExceed	ACL or extended ACL rules are not matched.	The quota for access control policies or extra access control policies is exhausted.
400	ErrorDBDelete	An error occurred while deleting the database.	An error occurred while deleting the database.
400	ErrorAddressGroupExist	The address group already exists.	The address group already exists.
400	ErrorAclDomainAnyCountExceed	The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.	The domain name is resolved to more than 200 IP addresses. We recommend that you set Application in your access control policy to HTTPS, HTTPS, SMTP, SMTPS, or SSL.
400	ErrorParametersAddressGroupAddressNotFound	The address to be deleted does not exist in the address book.	The address to be deleted does not exist in the address book.
400	InvalidParameter.AddressBook.AddressDuplicate	The address book address %s is already exist.	The address book address %s is already exist.
400	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.	The ACK cluster connector is operating.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorParametersMemberUidMismatch	The memberUid mismatch the aliUid.	The memberUid mismatch the aliUid.
401	ErrorAuthentication	An authentication error occurred.	An authentication error occurred.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.	The specified resource ACK cluster connector is not found.