Release a contiguous EIP group with ReleaseEipSegmentAddress - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Releases a contiguous Elastic IP Address (EIP) group by calling ReleaseEipSegmentAddress.

Operation description

The ReleaseEipSegmentAddress operation releases all EIPs in a contiguous EIP group.
Before you call ReleaseEipSegmentAddress, make sure that:
- All EIPs in the contiguous EIP group are in the unassociated state. To disassociate an EIP from a cloud resource, call UnassociateEipAddress.
- All EIPs in the contiguous EIP group are not added to an Internet Shared Bandwidth instance. To remove an EIP from an Internet Shared Bandwidth instance, call RemoveCommonBandwidthPackageIp.
ReleaseEipSegmentAddress is an asynchronous operation. After you send a request, the system returns a request ID, but the contiguous EIP group is not yet released. The release task continues to run in the background. You can call DescribeEipSegment to query the status of the contiguous EIP group:
- If the contiguous EIP group is in the Releasing state, the EIPs are being released. In this state, you can only perform query operations.
- If the contiguous EIP group cannot be found, the EIPs have been released.
ReleaseEipSegmentAddress does not support concurrent release of the same contiguous EIP group.

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

delete

*SegmentAddress

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the contiguous EIP group. You can call DescribeRegions to query the region ID.	cn-hangzhou
SegmentInstanceId	string	Yes	The instance ID of the contiguous EIP group to release. The system releases all EIPs in the contiguous EIP group.	eipsg-2zett8ba055tbsxme****
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-11e9-8e44-001sdfg

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F7A6301A-64BA-41EC-8284-8F4838C15D1F

Examples

Success response

JSON format

{
  "RequestId": "F7A6301A-64BA-41EC-8284-8F4838C15D1F"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectEipStatus	Current elastic IP status does not support this operation.
400	Forbidden.ChargeTypeIsPrepaid	It's forbidden to release a prepaid EIP
400	Forbidden	The eip instance owener error	The EIP does not belong to your account. Check whether you have the permissions to perform the operation on the EIP.
400	TaskConflict.AssociateGlobalAccelerationInstance	Operate too frequent.
400	InvalidOperation.DeletionProtection	The instance cannnot delete because of deletion protecion.
400	OperationFailed.InstanceNotExist	Operation failed because eip segment instance not exist.
400	OperationFailed.EipNumInconsistent	Operation failed because the number of eip is inconsistent.
400	OperationFailed.EipStatusInvalid	Operation failed because eip instance status invalid.	The operation failed because the status of the EIP is invalid.
400	OperationFailed.EipInBwp	Operation failed because eip instance has been added to the bandwidth package.
400	Forbidden.EipInBwp	The EIP has been associated with an EIP bandwidth plan.	You cannot delete the contiguous EIP group because EIPs in the group are associated with an EIP bandwidth plan.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidAllocationId.NotFound	Specified allocation ID is not found.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.