Creates an IP address pool.

Limits

Only users who have the required permissions can use the IP address pool feature of Elastic IP Address (EIP). To apply for the required permissions, submit a ticket.

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 CreatePublicIpAddressPool

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

Isp String No BGP

The line type. Valid values:

  • BGP (default): BGP (Multi-ISP) lines All regions support BGP (Multi-ISP) EIPs.
  • BGP_PRO: BGP (Multi-ISP) Pro lines Only the China (Hong Kong) region supports BGP (Multi-ISP) Pro EIPs.

For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.

If you are allowed to use single-ISP bandwidth, you can also choose one of the following values:

  • ChinaTelecom: China Telecom
  • ChinaUnicom: China Unicom
  • ChinaMobile: China Mobile
  • ChinaTelecom_L2: China Telecom L2
  • ChinaUnicom_L2: China Unicom L2
  • ChinaMobile_L2: China Mobile L2
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 02fb3da4-130e-11****

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 ensure that it is unique among different requests. ClientToken can contain only ASCII characters.

DryRun Boolean No false

Specifies whether to check the request without performing the operation. Valid values:

  • true: checks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.
RegionId String Yes cn-chengdu

The ID of the region where you want to create the IP address pool.

Response parameters

Parameter Type Example Description
PulbicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreatePublicIpAddressPool
&Isp=BGP
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=02fb3da4-130e-11****
&DryRun=false
&RegionId=cn-chengdu
&Common request parameters

Sample success responses

XML format

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

<CreatePublicIpAddressPoolResponse>
    <PulbicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PulbicIpAddressPoolId>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</CreatePublicIpAddressPoolResponse>

JSON format

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

{
  "PulbicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx****",
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

Error codes

For a list of error codes, visit the API Error Center.