All Products
Search
Document Center

Virtual Private Cloud:ReleaseEipSegmentAddress

Last Updated:Aug 29, 2024

Releases contiguous elastic IP addresses (EIPs).

Operation description

  • After you call the ReleaseEipSegmentAddress operation, all EIPs in the specified group are released.

  • ReleaseEipSegmentAddress is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeEipSegment operation to query the status of the task.

    • If the group is in the Releasing state, EIPs in the group are being released. In this state, you can only query the group and cannot perform other operations.
    • If you cannot query the group of contiguous EIPs, the contiguous EIPs are released.
  • You cannot repeatedly call the ReleaseEipSegmentAddress operation to release a group of contiguous EIPs within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 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:ReleaseEipSegmentAddressdelete
  • SegmentAddress
    acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the contiguous EIPs. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
SegmentInstanceIdstringYes

The ID of the contiguous EIP group to be released.

The system releases all EIPs in the group.

eipsg-2zett8ba055tbsxme****
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 different 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 may be different for each request.
02fb3da4-130e-11e9-8e44-001sdfg

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

F7A6301A-64BA-41EC-8284-8F4838C15D1F

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IncorrectEipStatusCurrent elastic IP status does not support this operation.You cannot perform the operation when the specified EIP is in the current state.
400Forbidden.ChargeTypeIsPrepaidIt's forbidden to release a prepaid EIPYou cannot release subscription EIPs.
400ForbiddenThe eip instance owener errorThe EIP does not belong to your account. Check whether you have the permissions to perform the operation on the EIP.
400TaskConflict.AssociateGlobalAccelerationInstanceOperate too frequent.The number of requests that you send exceeds the upper limit.
400InvalidOperation.DeletionProtectionThe instance cannnot delete because of deletion protecion.-
400OperationFailed.InstanceNotExistOperation failed because eip segment instance not exist.-
400OperationFailed.EipNumInconsistentOperation failed because the number of eip is inconsistent.-
400OperationFailed.EipStatusInvalidOperation failed because eip instance status invalid.The operation failed because the status of the EIP is invalid.
400OperationFailed.EipInBwpOperation failed because eip instance has been added to the bandwidth package.-
400Forbidden.EipInBwpThe 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.
404InvalidAllocationId.NotFoundSpecified allocation ID is not found.The error message returned because the specified EIP does not exist. Check whether the value of the parameter is valid.
404Forbidden.RegionNotFoundSpecified region is not found during access authentication.The specified region does not exist. Check whether the specified region ID is valid.
500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.

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

Change history

Change timeSummary of changesOperation
2023-06-26The Error code has changedView Change Details
2023-05-15The Error code has changedView Change Details