tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

OfflineIsolatedInstances

Last updated: 2024-01-30 10:25:56

    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.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: OfflineIsolatedInstances.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    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

    POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OfflineIsolatedInstances
<Common request parameters>

{
    "InstanceIds": [
        "cdb-70zdmgg1"
    ]
}

    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

    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.FtpError File transfer exception
    InternalError.UndefinedError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy