IsolateDBInstance

Last updated: 2020-03-04 23:46:53

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.

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 parameter. The value used for this API: IsolateDBInstance.
Version Yes String Common parameter. The value used for this API: 2019-07-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-shanghai, na-ashburn
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 parameter>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Invalid parameter.
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.