DeletionProtection-阿里云帮助中心

Operation description

After you enable deletion protection for an instance, you cannot delete the instance. To delete the instance, disable deletion protection first.

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

delete

*Address

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance for which you want to enable or disable deletion protection. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ProtectionEnable	boolean	Yes	Specifies whether to enable deletion protection. Valid values: true: enables deletion protection. false: disables deletion protection.	true
Type	string	Yes	The type of the instance for which you want to enable or disable deletion protection. Valid values: EIP: elastic IP address (EIP). CBWP: Internet Shared Bandwidth. NATGW: NAT gateway.	EIP
InstanceId	string	Yes	The ID of the instance for which you want to set deletion protection in Settings.	eip-uf6id7gvguruxe41v****
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 differ for each API request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID of the instance for which you want to configure deletion protection. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BAAEF103-96C4-4454-9210-066F2405F511

Examples

Success response

JSON format

{
  "RequestId": "BAAEF103-96C4-4454-9210-066F2405F511"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DeletionProtection.ResourceNotExist	The resource is not exist.	The resource does not exist.
400	DeletionProtection.PrePaidNotSupport	The prepaid resource is not support.	Subscription resources are not supported.
400	DeletionProtection.TypeNotSupport	The resource is not support.	This type of resource is not supported.
400	DeletionProtection.AlreadyEnabled	The resource deletion protection is already enabled.	Deletion protection is enabled.
400	DeletionProtection.OwnerError	The resource owner error.	The operation is not allowed because the resource does not belong to you.
404	InvalidAllocationId.NotFound	Specified allocation ID is not found	The specified EIP does not exist. Check whether the specified value is valid.
404	DeletionProtection.NotExist	The resource deletion protection is not found	Deletion protection is disabled.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.