All Products
Search

This Product

    Elastic IP Address:UpdatePublicIpAddressPoolAttribute

    Document Center

    Elastic IP Address:UpdatePublicIpAddressPoolAttribute

    Last Updated:Aug 28, 2026

    Modifies the attributes of an IP address pool.

    Operation description

    You cannot call the UpdatePublicIpAddressPoolAttribute operation to modify the attributes of an IP address pool multiple times within a specific period of time.

    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
    PublicIpAddressPoolId

    string

    Yes

    The ID of the IP address pool.

    pippool-6wetvn6fumkgycssx****
    Name

    string

    No

    The name of the IP address pool.

    The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.

    AddressPoolName
    Description

    string

    No

    The description of the IP address pool.

    The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    AddressPoolDescription
    ClientToken

    string

    No

    The client token used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must ensure that the token is unique across requests. The token can contain only ASCII characters.

    Note

    If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

    123e4567-e89b-12d3-a456-426655440000
    DryRun

    boolean

    No

    Specifies whether to perform a dry run without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.

    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

    false
    RegionId

    string

    Yes

    The region ID of the IP address pool to modify.

    cn-chengdu

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    4EC47282-1B74-4534-BD0E-403F3EE64CAF

    Examples

    Success response

    JSON format

    {
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalParam.Name The param of Name [%s] is illegal.
    400 IllegalParam.Description The param of Description [%s] is illegal. The error message returned because the Description parameter is set to an invalid value. Specify a valid values and try again.
    400 ResourceNotFound.PublicIpAddressPool The specified resource of PublicIpAddressPool [%s] is not found. The specified public IP address pool does not exist.
    400 OperationDenied.OperateSharedResource The operation is not allowed because of the PublicIpAddressPool is a shared resource. The public IP address pool is a shared resource and cannot be modified.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.