All Products
Search

This Product

    ApsaraDB for MongoDB:DestroyInstance

    Document Center

    ApsaraDB for MongoDB:DestroyInstance

    Last Updated:Jan 17, 2023

    Destroys an ApsaraDB for MongoDB instance.

    Operation Description

    Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:

    • The billing method of the instance is subscription.
    • The instance has expired and is in the Locking state.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:DestroyInstance WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/*
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    InstanceId string No

    The ID of the instance.

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

    The ID of the instance.

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

    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 make sure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

    		 ETnLKlblzczshOTUbOCz****
    ResourceGroupId string No

    The ID of the resource group.

    		 rg-acfmyiu4ekp****

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

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

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    400 ChargeTypeViolation The operation is not permitted due to charge type of the instance.
    400 MissingDBInstanceId DBInstanceId is mandatory for this action.

    For a list of error codes, visit the API error center.