Call the CreatePublicIpAddressPool API to create an IP address pool - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Creates an IP address pool by calling the CreatePublicIpAddressPool operation.

Operation description

The IP address pool feature is not available by default. To use this feature, apply for the IP address pool feature privilege quota in Quota Center. For more information, see Increase a quota in Quota Center.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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: BGP (default): BGP (multi-ISP) line. BGP_PRO: BGP (multi-ISP) premium line. For more information about BGP (multi-ISP) lines and BGP (multi-ISP) premium lines, see EIP line types. If you are a whitelist user of single-ISP bandwidth, you can also select the following types: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 If you are a China (Hangzhou) Finance Cloud user, this parameter is required. Set the value to BGP_FinanceCloud.	BGP
Name	string	No	The name of the IP address pool instance. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	AddressPoolName
Description	string	No	The description of the IP address pool instance. The description must be 0 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 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 RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without creating the IP address pool. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the check succeeds, an HTTP 2xx status code is returned and the operation is performed.	false
ResourceGroupId	string	No	The ID of the resource group to which the IP address pool belongs.	rg-acfmxazb4pcdvf****
RegionId	string	Yes	The region ID of the IP address pool that you want to create.	cn-chengdu
BizType	string	No	The business type of the IP address pool. Valid values: CloudBox: CloudBox. Only CloudBox users can select this type. Default (default): indicates a non-special type.	Default
Zones	array	No	The zones of the IP address pool. This parameter is required only when BizType is set to CloudBox, which indicates that the business type of the IP address pool is CloudBox.
	string	No	The zones of the IP address pool. This parameter is required only when BizType is set to CloudBox, which indicates that the business type of the IP address pool is CloudBox. Only one zone can be specified.	ap-southeast-1-lzdvn-cb
Tag	array<object>	No	The tags of the resource.
	object	No	The tag.
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. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	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 and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
SecurityProtectionTypes	array	No	The security protection level. If this parameter is left empty, DDoS Protection (Basic) is used by default. If this parameter is set to AntiDDoS_Enhanced, DDoS Protection (Enhanced) is used.
	string	No	The security protection level. If this parameter is left empty, DDoS Protection (Basic) is used by default. If this parameter is set to AntiDDoS_Enhanced, DDoS Protection (Enhanced) is used.	AntiDDoS_Enhanced

Response elements

Element	Type	Description	Example
	object	The response struct.
PulbicIpAddressPoolId `deprecated`	string	The instance ID of the IPAM pool.	pippool-6wetvn6fumkgycssx****
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
ResourceGroupId	string	The ID of the resource group to which the IP address pool belongs.	rg-acfmxazb4pcdvf****
PublicIpAddressPoolId	string	The instance ID of the IPAM pool.	pippool-6wetvn6fumkgycssx****

Examples

Success response

JSON format

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

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	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.
400	IncorrectBusinessStatus.PublicIpAddressPool	The business status of publicIpAddressPool is incorrect.	The current service status does not support creating an IP address pool instance.
400	OptInRequired.PublicIpAddressPool	You are not authorized to use the requested service of publicIpAddressPool. Ensure that you have subscribed to the service you are trying to use.	You are not authorized to use the requested IP address pool service. Make sure you have subscribed to the service you are trying to use.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.