tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

IsolateDBInstance

Last updated: 2023-06-21 15:55:38

1. API Description

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

This API is used to isolate a monthly subscribed TencentDB for MariaDB 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: IsolateDBInstance.
Version Yes String Common Params. The value used for this API: 2017-03-12.
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 tdsql-dasjkhd. It is the same as the instance ID displayed on the TencentDB console. You can use the DescribeDBInstances API to query the ID, which is the value of the InstanceId output parameter.

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Isolating a monthly subscribed TencentDB for MariaDB instance

This example shows you how to isolate a monthly subscribed TencentDB for MariaDB instance.

Input Example

POST / HTTP/1.1Host: mariadb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: IsolateDBInstance<common request parameters>{    "InstanceIds": [        "tdsql-cq3ndzu7"    ]}

Output Example

{
    "Response": {
        "FailedInstanceIds": [],
        "RequestId": "15eec42b-2c7b-410b-8efc-46da52e217a9",
        "SuccessInstanceIds": [
            "tdsql-cq3ndzu7"
        ]
    }
}

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.ActionNotFound API not found
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been deleted.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy