Creates an IP address pool.
Operation description
By default, the IP address pool feature is unavailable. You can apply for the privilege to use the IP address pool feature in the Quota Center console. For more information, see the "Request a quota increase in the Quota Center console" section in the Manage EIP quotas topic.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:CreatePublicIpAddressPool | create | *PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Isp | string | No | The line type. Valid values:
For more information about BGP (Multi-ISP) lines and BGP (Multi-ISP) Pro lines, see the "Line types" section in the What is EIP? topic.
| BGP |
| Name | string | No | 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 | AddressPoolName |
| Description | string | No | 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://. | AddressPoolDescription |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate a value, and you must make sure that each request has a unique token value. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId for each API request is different.
| 02fb3da4-130e-11**** |
| DryRun | boolean | No | Specifies whether to precheck only this request. Valid values:
| false |
| ResourceGroupId | string | No | The ID of the resource group to which the IP address pool belongs. | rg-acfmxazb4pcdvf**** |
| RegionId | string | Yes | The ID of the region where you want to create the IP address pool. | cn-chengdu |
| BizType | string | No | The service type of the IP address pool. Valid values:
| Default |
| Zones | array | No | The zone of the IP address pool. If you set BizType to CloudBox, this parameter is required. | |
| string | No | The zone of the IP address pool. If you set BizType to CloudBox, this parameter is required. You can specify only one zone. | ap-southeast-1-lzdvn-cb | |
| Tag | array<object> | No | The tag of the resource. | |
| object | No | |||
| Key | string | No | The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with | FinanceDept |
| Value | string | No | The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with | FinanceJoshua |
| SecurityProtectionTypes | array | No | The editions of Anti-DDoS.
| |
| string | No | The editions of Anti-DDoS.
| AntiDDoS_Enhanced |
Response parameters
Examples
Sample success responses
JSONformat
{
"PulbicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"ResourceGroupId": "rg-acfmxazb4pcdvf****"
}Error codes
| HTTP status code | 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 values 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. |
| 400 | MissingParam.Zones | The Zones parameter is required. | Zones is required. |
| 400 | UnsupportedRegion | The feature is not supported in current region. | The feature is not supported in the current region. |
| 400 | IllegalParam.Zones | The values of Zones [%s] are invalid. | Zones is set to an invalid value. |
| 400 | IllegalParamSize.Zones | An invalid number of zones is specified. | Zones is set to an invalid value. |
| 400 | UnsupportedFeature.Isp | The feature of Isp is not supported. | The ISP you specified is not currently supported. |
| 400 | OperationDenied.ISPNotSupportDdosEnhanced | The operation is not allowed because of DdosEnhanced is not supported by current isp. | The current ISP does not support the creation of an enhanced security protection address pool. |
| 400 | IllegalParam.SecurityProtectionTypes | The param of securityProtectionTypes is illegal. | The passed-in SecurityProtectionTypes parameter is invalid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-27 | The Error code has changed | View Change Details |
| 2024-03-04 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-01-22 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-12-08 | The Error code has changed | View Change Details |
| 2023-08-08 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-07-10 | The Error code has changed. The request parameters of the API has changed | View Change Details |