1. API Description
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to deactivate isolated TencentDB instances immediately. The instances must be in isolated status.
A maximum of 10 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.
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: OfflineIsolatedDBInstance. |
| 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 recycle bin, and copy the ID of the instance to be eliminated 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 Eliminating an isolated TencentDB instance
https:
&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 |
| InvalidParameter.PermissionDenied |
The current sub-account has no permission to perform this operation. |
| InvalidParameterValue.IllegalStatusToOffline |
The instance cannot be deactivated in the current status. Only isolated instances can be deactivated. |
| InvalidParameterValue.InstanceHasBeenDeleted |
The instance has been deleted. |
| InvalidParameterValue.LockFailed |
Instance lock failed. |
| InvalidParameterValue.NotFoundInstance |
The instance was not found. |
| InvalidParameterValue.StatusAbnormal |
The instance is in a status where operations are not allowed. |