All Products
Search

This Product

    Virtual Private Cloud:UpdatePublicIpAddressPoolAttribute

    Document Center

    Virtual Private Cloud:UpdatePublicIpAddressPoolAttribute

    Last Updated:Dec 20, 2024

    Modifies the attributes of an IP address pool.

    Operation description

    You cannot repeatedly call the UpdatePublicIpAddressPoolAttribute operation to modify the attributes of an IP address pool within the specified period of time.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:UpdatePublicIpAddressPoolAttribute
    *PublicIpAddressPool
    acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    PublicIpAddressPoolIdstringYes

    The ID of the IP address pool.

    		pippool-6wetvn6fumkgycssx****
    NamestringNo

    The name of the IP address pool.

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

    		AddressPoolName
    DescriptionstringNo

    The description of the IP address pool.

    This parameter is optional. If you enter a description, the description must be 2 to 256 characters in length, and cannot start with http:// or https://.

    		AddressPoolDescription
    ClientTokenstringNo

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

    You can use the client to generate the token, but you must make sure that the token is unique among different 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
    DryRunbooleanNo

    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
    RegionIdstringYes

    The region ID of the IP address pool that you want to modify.

    		cn-chengdu

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.Name The param of Name [%s] is illegal.The error message returned because the Name parameter is set to an invalid value. Specify a valid value and try again.
    400IllegalParam.DescriptionThe 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.
    400ResourceNotFound.PublicIpAddressPoolThe specified resource of PublicIpAddressPool [%s] is not found.The specified public IP address pool does not exist.
    400OperationDenied.OperateSharedResourceThe 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.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history