ModifyDBInstanceDeletionProtection - ApsaraDB RDS - Alibaba Cloud Documentation Center

Enable or disable the release protection feature for an instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

References

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Enable and disable instance release protection for an ApsaraDB RDS for MySQL instance
Enable and disable instance release protection for an ApsaraDB RDS for PostgreSQL instance
Enable and disable instance release protection for an ApsaraDB RDS for SQL Server instance
Enable and disable release protection for an ApsaraDB RDS for MariaDB instance

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:ModifyDBInstanceDeletionProtection	update	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
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 generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
DeletionProtection	boolean	Yes	Specifies whether to enable the release protection feature for the read-only instance. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	3C5CFDEE-F774-4DED-89A2-1D76EC63C575

Examples

Sample success responses

JSONformat

{
  "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.PayType	The operation is not permitted due to pay type of instance.	The operation failed. The operation is not supported for the billing method of the RDS instance.

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

Change history

Change time	Summary of changes	Operation
2022-02-28	Add Operation	View Change Details