Modifies the attributes of an IP address pool.

Usage notes

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdatePublicIpAddressPoolAttribute

The operation that you want to perform. Set the value to UpdatePublicIpAddressPoolAttribute.

PublicIpAddressPoolId String Yes pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

Name String No AddressPoolName

The name of the IP address pool.

This parameter is optional. If you enter a name, 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://.

Description String No AddressPoolDescription

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

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. The value of RequestId may be different for each API request.
DryRun Boolean No false

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and 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 sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
RegionId String Yes cn-chengdu

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

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdatePublicIpAddressPoolAttribute
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&RegionId=cn-chengdu
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdatePublicIpAddressPoolAttributeResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</UpdatePublicIpAddressPoolAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
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 error message returned because 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 error message returned because the public IP address pool is a shared resource and cannot be modified.

For a list of error codes, see Service error codes.