Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to add instances 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: AddInstances. |
| 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. |
| Cpu | Yes | Integer | Cpu cores |
| Memory | Yes | Integer | Memory in GB |
| ReadOnlyCount | Yes | Integer | Number of added read-only instances. Value range: (0,16]. |
| DeviceType | No | String | Instance Machine Type. Supported values are as follows:
|
| VpcId | No | String | ID of the associated VPC network. |
| SubnetId | No | String | Subnet ID. If VpcId is set up, SubnetId is required. |
| Port | No | Integer | The port used when adding an RO group. Value range: [0,65535). |
| InstanceName | No | String | Instance name. String length range: [0,64). |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: Yes; 0: No. Default is 0. |
| DbType | No | String | Database type, value ranges from...to...: |
| OrderSource | No | String | Order source, string length range [0,64) |
| DealMode | No | Integer | Transaction mode. 0: place order and pay; 1: place order |
| ParamTemplateId | No | Integer | Parameter template ID |
| InstanceParams.N | No | Array of ModifyParamItem | Parameter list. InstanceParams is valid only when ParamTemplateId is passed in. |
| SecurityGroupIds.N | No | Array of String | Security group ID. You can specify security groups when creating a read-only instance. |
| UpgradeProxy | No | UpgradeProxy | proxy sync upgrade |
| Parameter Name | Type | Description |
|---|---|---|
| TranId | String | Freeze transaction. One frozen flow is activated at a time. |
| DealNames | Array of String | Order ID for payment. Description: Recommend you use the DescribeResourcesByDealName api to query order associated instance. |
| BigDealIds | Array of String | Large order number |
| 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 example shows you how to add a read-only instance.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddInstances
<Common request parameters>
{
"ReadOnlyCount": 1,
"VpcId": "vpc-1ptuei0b",
"ClusterId": "cynosdbmysql-6gtlgm5l",
"Memory": 4,
"SubnetId": "subnet-1tmw9t4o",
"Cpu": 2,
"UpgradeProxy": {
"Cpu": 4,
"Mem": 8000,
"ReloadBalance": "auto",
"ProxyZones": [
{
"ProxyNodeZone": "ap-guangzhou-3",
"ProxyNodeCount": 1
}
]
}
}
{
"Response": {
"TranId": "myTranId",
"DealNames": [
"182711111"
],
"ResourceIds": [
"cynosdbmysql-mwg712mm"
],
"BigDealIds": [
"137895"
],
"RequestId": "48fa5cf5-77db-4e32-90ef-22c71ed95f51"
}
}
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 | 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. |
文档反馈