All Products
Search

This Product

    Cloud Firewall:ModifyAddressBook

    Document Center

    Cloud Firewall:ModifyAddressBook

    Last Updated:Dec 15, 2025

    Modifies an address book.

    Operation description

    This API is used to modify an address book.

    QPS limit

    The QPS limit for this API is 10 requests per second per user. Exceeding this limit triggers rate limiting, which can affect your business. Call this API only as needed.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    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

    A list of addresses in the address book. Separate multiple addresses with commas. Within each address element, separate the address and its description with a space. You must specify this parameter when GroupType is ip, port, or domain.

    • When GroupType is 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 port, specify ports or port ranges. Example: 80/80 HTTP port, 100/200,3306 database port.

    • When GroupType is domain, specify domain names. Example: demo1.aliyun.com test domain, 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

    Obtain this value from DescribeAddressBook.

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

    string

    No

    Specifies whether to automatically add public IP addresses of new ECS instances that match the specified tags to the address book.

    Valid values:

    • 0 :

      Do not automatically add

    • 1 :

      Automatically add

    1
    TagRelation

    string

    No

    The relationship between multiple ECS tags.

    Valid values:

    • or :

      Match any tag. Public IP addresses of ECS instances that match at least one tag are added to the address book.

    • and :

      Match all tags. Only public IP addresses of ECS instances that match all specified tags are added to the address book.

    and
    TagList

    array<object>

    No

    A list of ECS tags.

    object

    No

    An ECS tag.

    TagValue

    string

    No

    The tag value of the ECS instance.

    1
    TagKey

    string

    No

    The tag key of the ECS instance.

    TXY
    ModifyMode

    string

    No

    The modification mode.

    Note

    When GroupType is ip, ipv6, port, or domain, the default mode is Cover if this parameter is not specified.

    Important When GroupType is tag, this parameter must be empty.

    Valid values:

    • Delete :

      Deletes addresses specified by the AddressList parameter from the address book.

    • Cover :

      Replaces the existing address book with the addresses specified by the AddressList parameter.

    • Append :

      Adds the addresses specified by the AddressList parameter to the end of the existing address book.

    Cover
    AckNamespaces

    array

    No

    A list of ACK cluster pod namespaces.

    Note

    Up to 10 namespaces are allowed.

    string

    No

    An ACK cluster pod namespace. Obtain valid values from:

    Note

    This parameter is required when GroupType is ackNamespace.

    default
    AckLabels

    array<object>

    No

    A list of ACK cluster pod labels.

    Note

    Up to 10 labels are allowed.

    object

    No

    An ACK cluster pod label. Obtain valid values from:

    Note

    This parameter is required when GroupType is 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

    When you call this API, you must include the common request parameters for Alibaba Cloud APIs in addition to the parameters described in this topic. For more information about common request 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 ID of the request.

    CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

    Examples

    Success response

    JSON format

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

    Error codes

    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.
    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.