OfflineIsolatedInstances

Last updated: 2022-01-19 11:36:27

1. API Description

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

This API (OfflineIsolatedInstances) is used to deactivate isolated TencentDB instances immediately. The instances must be in isolated status, i.e., their Status value is 5 in the return of the instance list querying API.

This is an asynchronous API. There may be a delay in repossessing some resources. You can query the details by using the instance list querying API and specifying the InstanceId and the Status value as [5, 6, 7]. If the returned instance is empty, then all its resources have been released.

Note that once an instance is deactivated, its resources and data will not be recoverable. Please do so 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: OfflineIsolatedInstances.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-20.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N	Yes	Array of String	Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Eliminating an isolated TencentDB instance

Input Example

https://cdb.tencentcloudapi.com/?Action=OfflineIsolatedInstances
&InstanceIds.0=cdb-70zdmgg1
&<Common request parameters>

Output Example

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

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
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.

Recent Pages