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 limits

The queries per second (QPS) limit per user is 10. If this limit is exceeded, API calls are throttled, which may affect your services. Make API calls at a reasonable rate.

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
ClientToken	string	No	The idempotency token.	ddadxefexxxx
DryRun	boolean	No	The dry run mode.
SourceIp `deprecated`	string	No	The source IP address of the requester.	192.0.XX.XX
Lang	string	No	The language type. Valid values: en : English. zh : Chinese (default)	zh
AddressList	string	No	The list of addresses in the address book. Separate multiple addresses with commas (,). For each address element, separate the address and the description with a space. You must specify this parameter when GroupType is set to ip, port, or domain. If GroupType is set to ip, enter IP addresses in the address list. Example: 1.2.XX.XX/32 Development CIDR block,10.0.0.X/24,1.2.XX.XX/24 Test CIDR block. If GroupType is set to port, enter ports or port ranges in the address list. Example: 80/80 HTTP port,100/200,3306 Database port. If GroupType is set to domain, enter domain names in the address list. 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 UUID of the address book. Note To obtain the value, call the DescribeAddressBook operation.	0657ab9d-fe8b-4174-b2a6-6baf358e****
AutoAddTagEcs	string	No	Specifies if the automatic addition of the public IP addresses of Elastic Compute Service (ECS) instances that match the new labels to the address book is enabled. Valid values: 0 : Do not automatically add. 1 : Automatically add.	1
TagRelation	string	No	The relationship between multiple ECS tags. Valid values: or : or: The logical OR relation is used. The public IP addresses of Elastic Compute Service (ECS) instances are added to the address book if they match at least one label. and : and: The logical AND relation is used. The public IP addresses of Elastic Compute Service (ECS) instances are added to the address book only if they match all the labels.	and
TagList	array<object>	No	The list of ECS tags.
	object	No	The ECS tag.
TagKey	string	No	The key of the ECS tag.	TXY
TagValue	string	No	The value of the ECS tag.	1
ModifyMode	string	No	The modification mode. Note If GroupType is set to ip, ipv6, port, or domain and this parameter is not specified, the Cover mode is used by default to modify the address book. Important If GroupType is set to tag, this parameter must be left empty. Valid values: Delete : Delete: Removes the addresses specified by the AddressList parameter from the address book. Append : Append: Appends the addresses specified by the AddressList parameter to the original address book. Cover : Cover: Overwrites the original address book with the addresses specified by the AddressList parameter.	Cover
AckNamespaces	array	No	The list of pod namespaces in the ACK cluster. Note A maximum of 10 namespaces are supported.
	string	No	The pod namespace in the ACK cluster. Value source: DescribeAckClusterNamespaces: Queries the namespaces of ACK clusters. Note Required when GroupType is set to ackNamespace.	default
AckLabels	array<object>	No	The list of pod labels in the ACK cluster. Note A maximum of 10 labels are supported.
	object	No	The pod label in the ACK cluster. Value source: DescribeAckClusterPodLabels: Queries the pod labels of ACK clusters. Note Required when GroupType is set to ackLabel.	default
Key	string	No	The key of the pod label in the ACK cluster.	app
Value	string	No	The value of the pod label in the ACK cluster.	storage-operator
AssetMemberUids	array	No	The list of member accounts in the asset address book.
	integer	No	The member accounts.	13580xxxxxx6271
AssetRegionResourceTypes	array<object>	No	The asset address book, region, and resource type list.
	array<object>	No	The region and resource type list.
AssetRegionId	string	No	The asset region ID. Valid values: all : All regions.	all
ResourceType	object	No	The asset type.
Ipv4	object	No	The IPv4 asset type.
AiGatewayEIP	boolean	No	The asset type: AIGatewayEIP. Valid values: false : Disabled. true : Enabled.	false
AlbEIP	boolean	No	The asset type: AlbEIP. Valid values: false : Disabled. true : Enabled.	false
ApiGatewayEIP	boolean	No	The asset type: ApigEIP. Valid values: false : Disabled. true : Enabled.	false
BastionHostEgressIP	boolean	No	The asset type: BastionHostEgressIP. Valid values: false : Disabled. true : Enabled.	false
BastionHostIP	boolean	No	The asset type: BastionHostIP. Valid values: false : Disabled. true : Enabled.	false
BastionHostIngressIP	boolean	No	The asset type: BastionHostIngressIP. Valid values: false : Disabled. true : Enabled.	false
EIP	boolean	No	The asset type: EIP. Valid values: false : Disabled. true : Enabled.	false
EcsEIP	boolean	No	The asset type: EcsEIP. Valid values: false : Disabled. true : Enabled.	false
EcsPublicIP	boolean	No	The asset type: EcsPublicIP. Valid values: false : Disabled. true : Enabled.	false
EniEIP	boolean	No	The asset type: EniEIP. Valid values: false : Disabled. true : Enabled.	false
GaEIP	boolean	No	The asset type: GaEIP. Valid values: false : Disabled. true : Enabled.	false
HAVIP	boolean	No	The asset type: HAVIP. Valid values: false : Disabled. true : Enabled.	false
NatEIP	boolean	No	The asset type: NatEIP. Valid values: false : Disabled. true : Enabled.	false
NatPublicIP	boolean	No	The asset type: NatPublicIP. Valid values: false : Disabled. true : Enabled.	false
NlbEIP	boolean	No	The asset type: NlbEIP. Valid values: false : Disabled. true : Enabled.	false
SlbEIP	boolean	No	The asset type: SlbEIP. Valid values: false : Disabled. true : Enabled.	true
SlbPublicIP	boolean	No	The asset type: SlbPublicIP. Valid values: false : Disabled. true : Enabled.	false
Ipv6	object	No	The IPv6 asset type.
AiGatewayEIPv6	boolean	No	The asset type: AIGatewayEIPv6. Valid values: false : Disabled. true : Enabled.	false
AlbIPv6	boolean	No	The asset type: AlbIPv6. Valid values: false : Disabled. true : Enabled.	false
ApiGatewayEIPv6	boolean	No	The asset type: ApigEIPv6. Valid values: false : Disabled. true : Enabled.	false
EcsIPv6	boolean	No	The asset type: EcsIPv6. Valid values: false : Disabled. true : Enabled.	false
EniEIPv6	boolean	No	The asset type: EniEIPv6. Valid values: false : Disabled. true : Enabled.	false
GaEIPv6	boolean	No	The asset type: GaEIPv6. Valid values: false : Disabled. true : Enabled.	false
NlbIPv6	boolean	No	The asset type: NlbIPv6. Valid values: false : Disabled. true : Enabled.	false
SlbIPv6	boolean	No	The asset type: SlbIPv6. Valid values: false : Disabled. true : Enabled.	false

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

Response elements

Element	Type	Description	Example
	object
DryRun	boolean	Indicates whether the request is a successful dry run. A value of true indicates that only the dry run is performed and no actual modifications are made.
RequestId	string	The ID of the request.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

Examples

Success response

JSON format

{
  "DryRun": false,
  "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.	ACL or extended ACL rules are not matched.
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.
400	InvalidClientToken	ClientToken format invalid. Only ASCII letters, digits, hyphens and underscores are allowed, max 64 characters.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	This request uses the same client token as the previous request, but not the same. Do not reuse client tokens in different requests unless the request is the same.
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.
409	IdempotentToken.Processing	A previous request with the same ClientToken is still being processed.