tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

IsolateDCDBInstance

Last updated: 2024-07-19 14:30:18

    1. API Description

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

    This API is used to isolate a monthly subscribed TDSQL instance, which will no longer be accessible via IP and port. The isolated instance can be started up in the recycle bin. If it is isolated due to overdue payments, top up your account as soon as possible.

    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: IsolateDCDBInstance.
    Version Yes String Common Params. The value used for this API: 2018-04-11.
    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 tdsqlshard-avw0207d, which is the same as the instance ID displayed on the TencentDB console and can be queried through the DescribeDBInstances API.

    3. Output Parameters

    Parameter Name Type Description
    SuccessInstanceIds Array of String IDs of isolated instances
    FailedInstanceIds Array of String IDs of instances failed to be isolated
    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 Isolating a monthly subscribed TDSQL instance

    This example shows you how to isolate a monthly subscribed TDSQL instance.

    Input Example

    POST / HTTP/1.1Host: dcdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: IsolateDCDBInstance<common request parameters>{    "InstanceIds": [        "tdsqlshard-pevrkilh"    ]}

    Output Example

    {
    "Response": {
        "FailedInstanceIds": [],
        "RequestId": "e3b9a860-5864-43b2-8f0f-9684dea8fa58",
        "SuccessInstanceIds": [
            "tdsqlshard-pevrkilh"
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error
    FailedOperation.CreateOrderFailed Failed to create an order.
    FailedOperation.InstanceCanNotReturn Refund is not supported for the instance
    FailedOperation.InstanceReturnFailed Instance refund failed
    InternalError.OperateDatabaseFailed Database operation failed.
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    ResourceUnavailable.InstanceAlreadyDeleted The database instance has been dropped.
    ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy