All Products
Search
Document Center

ApsaraDB for MongoDB:DestroyInstance

Last Updated:Sep 03, 2024

Destroys an ApsaraDB for MongoDB instance.

Operation description

Before you call this operation, make sure that the instance meets the following requirements:

  • The instance is a replica set instance or a sharded cluster instance that uses local disks.
  • The billing method of the instance is subscription.
  • The instance has expired and is in the Locking state.

**

Warning Data cannot be restored after the instance is destroyed. Proceed with caution.

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
dds:DestroyInstancedelete
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The instance ID.

Note InstanceId and DBInstanceId serve the same function. You need only to specify one of them.
dds-bp147acd4783****
DBInstanceIdstringNo

The instance ID.

Note InstanceId and DBInstanceId serve the same function. You need only to specify one of them.
dds-bp147acd4783****
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz****
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmyiu4ekp****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

65BDA532-28AF-4122-AA39-B382721E****

Examples

Sample success responses

JSONformat

{
  "RequestId": "65BDA532-28AF-4122-AA39-B382721E****"
}

Error codes

HTTP status codeError codeError messageDescription
400ChargeTypeViolationThe operation is not permitted due to charge type of the instance.-
400MissingDBInstanceIdDBInstanceId is mandatory for this action.Invalid instance name.

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

Change history

Change timeSummary of changesOperation
2023-07-13The Error code has changedView Change Details