All Products
Search
Document Center

Virtual Private Cloud:TransformEipSegmentToPublicIpAddressPool

Last Updated:Mar 21, 2025

Migrate a contiguous EIP group to an IP address pool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:TransformEipSegmentToPublicIpAddressPoolcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the contiguous EIP group to be migrated.

eipsg-2zett8ba055tbsxme****
RegionIdstringYes

The ID of the region to which the contiguous EIP group belongs. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
NamestringNo

The name of the IP address pool.

The name must be 0 to 128 characters in length and cannot start with http:// or https://.

AddressPoolName
DescriptionstringNo

The description of the IP address pool.

The description must be 0 to 256 characters in length and cannot start with http:// or https://.

AddressPoolDescription
ResourceGroupIdstringNo

The ID of the resource group to which the address pool belongs.

rg-acfmxazb4pcdvf****
ClientTokenstringNo

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 all requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.
02fb3da4-130e-11****

Response parameters

ParameterTypeDescriptionExample
object
PublicIpAddressPoolIdstring

The ID of the IP address pool.

pippool-6wetvn6fumkgycssx****
ResourceGroupIdstring

The ID of the resource group to which the IP address pool belongs.

rg-acfmxazb4pcdvf****
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Forbidden.RAMUser not authorized to operate on the specified resourceThe RAM user is unauthorized to perform the operation.
400Forbidden.RAMThe user is not authorized to operate on the specified resource, or the API operation does not support RAM.-
400IllegalParam.NameThe 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.
400IllegalParam.DescriptionThe 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.
400Forbidden.CreatePublicIpAddressPoolAuthentication 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.
400QuotaExceeded.PublicIpAddressPoolThe 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.
400UnsupportedRegionThe feature is not supported in current region.The feature is not supported in the current region.
400IncorrectBusinessStatus.PublicIpAddressPoolThe business status of publicIpAddressPool is incorrect.The current service status does not support creating an IP address pool instance.
400OptInRequired.PublicIpAddressPoolYou 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.
400QuotaExceeded.PoolIpQuantityThe quota of PoolIpQuantity is exceeded.The number of IP addresses in the pool has reached the upper limit.
400ResourceNotFound.EipSegmentThe specified resource of Eip Segment is not found.The passed-in consecutive EIP group instances do not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history