Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to add read-only analysis engine to a cluster.
A maximum of 20 requests can be initiated per second for this API.
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: AddLibraDBInstances. |
| 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. |
| Zone | Yes | String | Availability zone |
| ClusterId | Yes | String | Cluster ID |
| Cpu | Yes | Integer | CPU cores |
| Mem | Yes | Integer | Memory in GB |
| StorageSize | Yes | Integer | Disk size. |
| PayMode | Yes | Integer | Payment mode |
| Objects | Yes | Objects | Sync object list |
| Port | No | Integer | Port used when adding new RO groups, value range [0,65535) |
| GoodsNum | No | Integer | Number of newly-added read-only instances, value range (0,15] |
| InstanceName | No | String | Instance name, string length range [0,64), value range uppercase and lowercase letters, digits 0-9, '_', '-', '.' |
| ReplicasNum | No | Integer | Number of replicas |
| InstanceType | No | String | Value is 'Exclusive' when ReplicasNum>1 or ReplicasNum=1 and Cpu>=32 cores, and 'Common' in other scenarios. |
| StorageType | No | String | Disk type. |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: Yes; 0: No. Default is 0. |
| OrderSource | No | String | Order source, string length range [0,64) |
| DealMode | No | Integer | Transaction mode 0-Place order and pay 1-Place order |
| VpcId | No | String | ID of the associated VPC network. |
| SubnetId | No | String | Subnet ID. If VpcId is set up, SubnetId is required. |
| SecurityGroupIds.N | No | Array of String | Security group ID. You can specify security groups when creating a read-only instance. |
| LibraDBVersion | No | String | Analysis engine version |
| TimeSpan | No | Integer | Purchase period, combined with TimeUnit for the changes to take effect |
| TimeUnit | No | String | Duration unit, takes effect when combined with TimeSpan. Options: day:d, month:m |
| SrcInstanceId | No | String | Source instance id |
| Parameter Name | Type | Description |
|---|---|---|
| BigDealIds | Array of String | Large order number. |
| TranId | String | Freeze transaction. One frozen flow is activated at a time. |
| DealNames | Array of String | Post-paid order number. |
| ResourceIds | Array of String | Delivery resource id list. |
| 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. |
This interface (AddLibraDBInstances) is used for adding a read-only analysis engine to a cluster.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddLibraDBInstances
<Common request parameters>
{
"Zone": "ap-guangzhou-7",
"ClusterId": "cynosdbmysql-037c8yll",
"Cpu": 4,
"Mem": 16,
"StorageSize": 100,
"PayMode": 0,
"Objects": {
"DatabaseTables": {
"MigrateDBMode": "all"
}
},
"GoodsNum": 1,
"VpcId": "vpc-nnakli31",
"SubnetId": "subnet-558rhwt2"
}{
"Response": {
"BigDealIds": null,
"DealNames": [
"20250417625002746837731"
],
"RequestId": "173601bd-d6ab-4774-8714-775b37c8613d",
"ResourceIds": [
"libradb-ins-7ohnx2nu"
],
"TranId": "20250417625002746837741"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
フィードバック