All Products
Search
Document Center

ApsaraDB for Redis:DeleteInstance

Last Updated:May 28, 2024

Release the Redis instance.

Operation description

For more information about how to perform the corresponding operation in the console, see Release an instance.

Before you call this operation, make sure that the following requirements are met:

  • The instance is in the running state.
  • The instance is charged on a pay-as-you-go basis.
Note You cannot call this operation to release a subscription instance, which is automatically released when it expires. To release a subscription instance before it expires, submit a ticket.

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
kvstore:DeleteInstanceWRITE
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance that you want to release.

r-bp1zxszhcgatnx****
GlobalInstanceIdstringNo

The ID of the distributed instance to which the instance belongs. This parameter is applicable to only China site (aliyun.com).

gr-bp14rkqrhac****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

5D622714-AEDD-4609-9167-F5DDD3D190D2

Examples

Sample success responses

JSONformat

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D190D2"
}

Error codes

HTTP status codeError codeError message
403InstanceReleaseProtectionThe operation is not permitted due to instance release protection.

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

Change history

Change timeSummary of changesOperation
No change history