tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

IsolateDBInstance

Last updated: 2023-03-20 10:55:14

1. API Description

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

This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. An isolated instance is retained in the recycle bin and data can no longer be written to it. After it is isolated for a certain period of time, it will be completely deleted. For the retention period in the recycle bin, please see the terms of service for pay-as-you-go billing. Isolated pay-as-you-go instances cannot be recovered, so please 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 No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

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

Input Example

https://mongodb.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

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
InternalError Internal error
InvalidParameter Parameter error
InvalidParameter.PermissionDenied The current subaccount 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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy