IsolateDBInstance

Last updated: 2025-12-03 10:42:00

IsolateDBInstance

Last updated: 2025-12-03 10:42:00

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. After isolation, the instance is retained in the recycle bin, and data cannot be written into it. After a certain period of isolation, the instance is deleted permanently. For the retention time in the recycle bin, see the pay-as-you-go service terms. The deleted pay-as-you-go instance cannot be recovered. Proceed with caution.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: IsolateDBInstance.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID. Log in to the TencentDB for MongoDB console, and copy the ID of the instance to be isolated from the instance list.

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	Async task request ID, which can be used to query the execution result of an async task.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Terminating a pay-as-you-go TencentDB instance

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=IsolateDBInstance
&InstanceId=cmgo-f555zzzz
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "28920"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DeletionProtectionEnabled	Termination protection is enabled for the instance. destruction is not allowed.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.InstanceHasBeenDeleted	The instance has been deleted.
InvalidParameterValue.InstanceHasBeenIsolated	The instance has been isolated.
InvalidParameterValue.LockFailed	Instance lock failed.
InvalidParameterValue.NotFoundInstance	The instance was not found.
InvalidParameterValue.PrePaidInstanceUnableToIsolate	Prepaid instances cannot be terminated.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud