Migrate EIP Segments to IP Address Pool for Unified Management - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Migrates a contiguous Elastic IP Address (EIP) group to an IP address pool.

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:TransformEipSegmentToPublicIpAddressPool

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the contiguous EIP group to migrate.	eipsg-2zett8ba055tbsxme****
RegionId	string	Yes	The region ID of the contiguous EIP group. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
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
ResourceGroupId	string	No	The resource group ID of the IP address pool.	rg-acfmxazb4pcdvf****
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****

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.RAM	User not authorized to operate on the specified resource
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	UnsupportedRegion	The feature is not supported in current region.	The feature is not supported in the current region.
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.
400	QuotaExceeded.PoolIpQuantity	The quota of PoolIpQuantity is exceeded.	The number of IP addresses in the pool has reached the upper limit.
400	ResourceNotFound.EipSegment	The specified resource of Eip Segment is not found.	The passed-in consecutive EIP group instances do not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.