Creates an IP address pool.
Limits
By default, the IP address pool feature is unavailable. You can apply for the privilege to use the IP address pool feature on the Quota Center page. For more information, see Request a quota increase in the Quota Center console.
Debugging
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:
For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.
|
Name | String | No | AddressPoolName | 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 |
Description | String | No | AddressPoolDescription | The description of the IP address pool. This parameter is optional. 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 you want to use to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among all requests. ClientToken can contain only ASCII characters. Note If you do not specify this parameter, the system uses RequestId as ClientToken. The value of RequestId for each API request may be different. |
DryRun | Boolean | No | false | Specifies whether to perform a dry run. Valid values:
|
ResourceGroupId | String | No | rg-acfmxazb4pcdvf**** | The ID of the resource group to which the IP address pool belongs. |
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. |
ResourceGroupId | String | rg-acfmxazb4pcdvf**** | The ID of the resource group to which the IP address pool belongs. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreatePublicIpAddressPool
&Isp=BGP
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=02fb3da4-130e-11****
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&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>
<ResourceGroupId>rg-acfmxazb4pcdvf****</ResourceGroupId>
</CreatePublicIpAddressPoolResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PulbicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx****",
"RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"ResourceGroupId" : "rg-acfmxazb4pcdvf****"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | IllegalParam.Isp | The param of Isp [%s] is illegal. | The error message returned because the Isp parameter is set to an invalid value. Specify a valid value and try again. |
400 | IllegalParam.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. |
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 value and try again. |
400 | Forbidden.CreatePublicIpAddressPool | Authentication is failed for creating public ip address pool. | The error message returned because you cannot create an IP address pool. Check whether you have the relevant permissions. |
400 | QuotaExceeded.PublicIpAddressPool | The quota of PublicIpAddressPool is exceeded. | The error message returned because the number of your IP address pools has reached the upper limit. Request a quota increase. |
For a list of error codes, see Service error codes.