tencent cloud

文档反馈

ActivateInstance

最后更新时间:2023-08-23 14:23:04

1. API Description

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

This API is used to remove the isolation of an instance to make it accessible again.

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: ActivateInstance.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
InstanceIdList.N Yes Array of String List of instance IDs in the format of cynosdbmysql-ins-n7ocdslw as displayed in the TDSQL-C for MySQL console. You can use the instance list querying API to query the ID, i.e., the InstanceId value in the output parameters.

3. Output Parameters

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

4. Example

Example1 Removing the isolation of an instance to make it accessible again

This example shows you how to remove the isolation of an instance to make it accessible again.

Input Example

https://cynosdb.tencentcloudapi.com/?Action=ActivateInstance
&ClusterId=cynosdbmysql-bzxxrmtq
&InstanceIdList.0=cynosdbmysql-ins-7upukfpw
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "128046",
        "FlowId": 123
    }
}

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
FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.PrePayPayModeError This operation is not allowed for monthly-subscribed instances.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceNotFound.ResourceError The resource corresponding to the parameter does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied CAM authentication failed.