产品动态
产品公告
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to purchase new clusters.
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: CreateClusters. |
| 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 | AZ |
| VpcId | Yes | String | VPC ID |
| SubnetId | Yes | String | Subnet ID |
| DbType | Yes | String | Database type. Valid values: |
| DbVersion | Yes | String | Database version. Valid values: MYSQL: 5.7 and 8.0 |
| ProjectId | No | Integer | Project ID. |
| Cpu | No | Integer | It is required when DbMode is set to NORMAL or left empty.Number of CPU cores of normal instance |
| Memory | No | Integer | It is required when DbMode is set to NORMAL or left empty.Memory of a non-serverless instance in GB |
| InstanceCount | No | Integer | Instance count. valid values: a quantity range from 0 to 16. the default value is 2 (that is, one rw instance + one ro instance). the transmitted n represents 1 rw instance + (n - 1) ro instances (with identical specifications). if a more precise cluster composition collocation is required, please use InstanceInitInfos. |
| Storage | No | Integer | This parameter has been deprecated. Storage capacity in GB |
| ClusterName | No | String | Cluster name, which can contain less than 64 letters, digits, or symbols (-_.). |
| AdminPassword | No | String | Account password, which must contain 8-64 characters in at least three of the following four types: uppercase letters, lowercase letters, digits, and symbols (~!@#$%^&*_-+=` |
| Port | No | Integer | Port. Valid range: [0, 65535). Default value: 3306 |
| PayMode | No | Integer | Billing mode. supported values: 0 and 1. default value: 0. Value is 0, indicating pay-as-you-go billing. Value is 1, which means yearly/monthly subscription. |
| Count | No | Integer | Number of purchased clusters. Valid range: [1,50]. Default value: 1 |
| RollbackStrategy | No | String | Rollback type: noneRollback: no rollback; snapRollback: rollback by snapshot; timeRollback: rollback by time point |
| RollbackId | No | Integer | snapshotId for snapshot rollback or queryId for time point rollback. 0 indicates to determine whether the time point is valid |
| OriginalClusterId | No | String | The source cluster ID passed in during rollback to find the source poolId |
| ExpectTime | No | String | Specified time for time point rollback or snapshot time for snapshot rollback |
| ExpectTimeThresh | No | Integer | This parameter has been deprecated. Specified allowed time range for time point rollback |
| StorageLimit | No | Integer | Storage upper limit of normal instance in GB If DbType is MYSQL and the storage billing mode is yearly/monthly subscription, the parameter value can't exceed the maximum storage corresponding to the CPU and memory specifications. |
| TimeSpan | No | Integer | Purchase duration of yearly/monthly subscription plan |
| TimeUnit | No | String | Duration unit of yearly/monthly subscription. Valid values: s, d, m, y |
| AutoRenewFlag | No | Integer | Specifies whether the annual/yearly/monthly subscription is auto-renewed. the default value is 0. 0 indicates the default renewal method. 1 means auto-renewal. 2 means no auto-renewal. |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: yes; 0: no. Default value: 0 |
| HaCount | No | Integer | Number of instances (this parameter has been disused and is retained only for compatibility with existing instances) |
| OrderSource | No | String | Order source |
| ResourceTags.N | No | Array of Tag | Array of tags to be bound to the created cluster |
| DbMode | No | String | Database type Valid values when DbType is MYSQL (default value: NORMAL): |
| MinCpu | No | Float | This parameter is required if DbMode is SERVERLESS.Minimum number of CPU cores. For the value range, see the returned result of DescribeServerlessInstanceSpecs. |
| MaxCpu | No | Float | This parameter is required if DbMode is SERVERLESS.Maximum number of CPU cores. For the value range, see the returned result of DescribeServerlessInstanceSpecs. |
| AutoPause | No | String | This parameter specifies whether the cluster will be automatically paused if DbMode is SERVERLESS. Valid values:Default value: yes |
| AutoPauseDelay | No | Integer | This parameter specifies the delay for automatic cluster pause in seconds if DbMode is SERVERLESS. Value range: [600,691200]Default value: 600 |
| StoragePayMode | No | Integer | The billing mode of cluster storage. Valid values: 0 (pay-as-you-go), 1 (yearly/monthly subscription). Default value: 0.If DbType is MYSQL and the billing mode of cluster compute is pay-as-you-go (or the DbMode is SERVERLESS), the billing mode of cluster storage must be pay-as-you-go.Clusters with storage billed in yearly/monthly subscription can't be cloned or rolled back. |
| SecurityGroupIds.N | No | Array of String | Array of security group IDs |
| AlarmPolicyIds.N | No | Array of String | Array of alarm policy IDs |
| ClusterParams.N | No | Array of ParamItem | Array of parameters. Valid values: character_set_server (utf8/latin1/gbk/utf8mb4), lower_case_table_names. 0: case-sensitive; 1: case-insensitive). |
| DealMode | No | Integer | Transaction mode. Valid values: 0 (place and pay for an order), 1 (place an order) |
| ParamTemplateId | No | Integer | Parameter template ID, which can be obtained by querying parameter template information "DescribeParamTemplates" |
| SlaveZone | No | String | Multi-AZ address |
| InstanceInitInfos.N | No | Array of InstanceInitInfo | Instance initialization configuration information, which is used to select instances with different specifications when purchasing a cluster. |
| GdnId | No | String | Global database unique identifier. |
| ProxyConfig | No | ProxyConfig | Database proxy configuration. |
| AutoArchive | No | String | Automatically archive. |
| AutoArchiveDelayHours | No | Integer | Archiving processing time after pausing. |
| CynosVersion | No | String | Kernel minor version number. |
| Parameter Name | Type | Description |
|---|---|---|
| TranId | String | Frozen transaction ID. |
| DealNames | Array of String | Order ID |
| ResourceIds | Array of String | Resource ID list (this field is no longer maintained. please use the dealNames field and the DescribeResourcesByDealName query API to obtain resource ids.). |
| ClusterIds | Array of String | Cluster ID list. this field is no longer maintained. please use the dealNames field and the DescribeResourcesByDealName query API to get the cluster ID. |
| BigDealIds | Array of String | Big order ID 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. |
Purchase a new cluster
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusters
<Common request parameters>
{
"Count": 1,
"StoragePayMode": 0,
"VpcId": "vpc-1ptuei0b",
"Zone": "ap-guangzhou-3",
"AdminPassword": "passwd@admin",
"DbType": "MYSQL",
"ProjectId": 0,
"DbVersion": "10.0",
"Storage": 100,
"PayMode": 0,
"ClusterName": "newInstance",
"StorageLimit": 100,
"RollbackStrategy": "noneRollback",
"Memory": 4,
"SubnetId": "subnet-1tmw9t4o",
"Cpu": 2,
"HaCount": 1
}
{
"Response": {
"ResourceIds": [
"cynosdbmysql-ins-67rmucgk"
],
"RequestId": "132075",
"TranId": "20190522160000003106844584180998",
"ClusterIds": [
"cynosdbmysql-sls-9nts65r2"
],
"BigDealIds": [
"142759"
],
"DealNames": [
"20190522112283"
]
}
}
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.CreateOrder | Failed to create the order and make a payment. |
| FailedOperation.InsufficientBalance | Insufficient account balance |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| FailedOperation.QuerySpecBySpecCodeError | Failed to query specifications. |
| 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.InternalHttpServerError | An exception occurred while executing the HTTP request. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.DBTypeNotFound | Unsupported instance type. |
| InvalidParameterValue.IllegalPassword | The password does not meet the requirement. |
| InvalidParameterValue.InvalidDBVersion | Invalid instance version. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
| InvalidParameterValue.InvalidSpec | Invalid instance specification. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ |
| InvalidParameterValue.ProjectIdNotFound | The ProjectId was not found. |
| 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.DisableNewStorageMultiZoneDeploymentError | |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.NewStorageOnlySupport80Error | |
| OperationDenied.OnlyNewStorageSupportStorageCompressionError | |
| OperationDenied.UserNotAuthenticatedError | You need to verify your identity to make a purchase. |
| UnauthorizedOperation.NotRealNameAccount | Users who haven't completed identity verification can’t make purchases. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈