tencent cloud

APIs

CheckCreateLibraDBInstance

Download
Focus Mode
Font Size
Last updated: 2026-05-25 20:21:24

1. API Description

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

This API is used to verify whether it is possible to add a read-only analysis engine instance to the cluster.

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: CheckCreateLibraDBInstance.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId Yes String Cluster ID
InstanceId No String Instance ID.

3. Output Parameters

Parameter Name Type Description
Status String Overall verification status
Note: This field may return null, indicating that no valid values can be obtained.
CheckItem Array of CheckItem Check item
Note: This field may return null, indicating that no valid values can be obtained.
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 Validate if it is possible to add read-only analysis engine to the cluster

This interface (CheckCreateLibraDBInstance) is used for verification to check if it is possible to add a read-only analysis engine instance to the cluster.

Input Example

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

{
    "ClusterId": "cynosdbmysql-6474meew",
    "InstanceId": ""
}

Output Example

{
    "Response": {
        "RequestId": "128046",
        "Status": "",
        "CheckItem": [
            {}
        ]
    }
}

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.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
FailedOperation.TradeCreateOrderError Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetSubnetFailed Failed to get the subnet.
InternalError.GetVpcFailed Failed to get the VPC.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.DBTypeNotFound Unsupported instance type.
InvalidParameterValue.IllegalPassword The password does not meet the requirement.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
InvalidParameterValue.InvalidSpec Invalid instance specification.
InvalidParameterValue.ParamError Incorrect parameter.
InvalidParameterValue.RegionZoneUnavailable The selected region and AZ are unavailable.
InvalidParameterValue.SubnetNotFound The selected subnet could not be found.
InvalidParameterValue.VpcNotFound The selected VPC could not be found.
LimitExceeded.UserInstanceLimit The number of instances exceeds the limit.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
OperationDenied.ClusterStatusDeniedError For the cluster in this status, the operation is not allowed.
OperationDenied.InsufficientBalanceError Insufficient account balance.
OperationDenied.UserNotAuthenticatedError You need to verify your identity to make a purchase.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback