tencent cloud

APIs

CheckCreateLibraDBInstance

下载
聚焦模式
字号
最后更新时间: 2026-10-22 10:45:55

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
CheckItem Array of CheckItem Check item
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 Database access failed. Try again later. If the issue persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
FailedOperation.TradeCreateOrderError Failed to create and pay for the order. Try again later. If the issue persists, contact customer service.
InternalError.DbOperationFailed Query database failed.
InternalError.GetSubnetFailed Failed to obtain 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 requirements.
InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
InvalidParameterValue.InvalidSpec Invalid instance specification.
InvalidParameterValue.ParamError Parameter error.
InvalidParameterValue.RegionZoneUnavailable The selected region and availability zone are unavailable.
InvalidParameterValue.SubnetNotFound Subnet not found.
InvalidParameterValue.VpcNotFound The selected VPC network is not found.
LimitExceeded.UserInstanceLimit Number of user instances exceeds the limit.
OperationDenied.ClusterOpNotAllowedError Operation forbidden. The current cluster does not allow this operation.
OperationDenied.ClusterStatusDeniedError Operation not allowed in the current status of the cluster.
OperationDenied.InsufficientBalanceError Insufficient account balance.
OperationDenied.UserNotAuthenticatedError User not verified with real-name authentication. Please proceed with real-name authentication before purchase.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈