Creates hosts in a dedicated cluster.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DedicatedHostGroupId |
string |
Yes |
The dedicated cluster ID. Available on the Dedicated Clusters page in the ApsaraDB for MyBase console. Note
The database engine of the host is the same as the database engine of the cluster. |
dhg-6w7q18iwt5jo**** |
| HostClass |
string |
Yes |
The host instance type. Supported types vary by database engine. Instance types of hosts. |
rds.g6.4xlarge |
| PayType |
string |
Yes |
The billing method of the host. Set the value to prepaid. |
prepaid |
| Period |
string |
No |
The unit of the subscription duration. Valid values:
|
Month |
| UsedTime |
string |
No |
The subscription duration of the host.
|
1 |
| ClientToken |
string |
Yes |
The client token for ensuring idempotence. Must be unique per request, ASCII-only, and no longer than 64 characters. |
ETnLKlblzczshOTUbOCzSBZH8**** |
| AutoRenew |
string |
No |
Whether to enable auto-renewal. Valid values:
Note
Default: false. |
false |
| ImageCategory |
string |
No |
The image of the host. Valid values:
Note
Required for SQL Server hosts. |
AliLinux |
| OsPassword |
string |
No |
The password of the host. You can specify a password only when you create a host in a Proprietary MyBase dedicated cluster.
|
Test123456 |
| HostStorageType |
string |
No |
The disk type of the host. This parameter takes effect only for dedicated clusters that run Tair. Valid values:
Valid values:
|
cloud_essd0 |
| HostStorage |
string |
No |
The disk storage of the host. This parameter takes effect only for dedicated clusters that run Tair. Unit: GB. Valid values:
|
512 |
| RegionId |
string |
Yes |
The region ID of the dedicated cluster. |
cn-hangzhou |
| ZoneId |
string |
Yes |
The zone ID. Call DescribeRegions to query available zones. |
cn-hangzhou-i |
| VSwitchId |
string |
Yes |
The vSwitch ID. Available in the VPC console. |
vsw-bp133c8ifzxd3iv6q**** |
| ClusterType |
string |
No |
The deployment type of the Self-managed MyBase cluster. Valid values: onACK and onECS. |
onACK |
| ClusterAlias |
string |
No |
The alias of the Self-managed MyBase cluster. |
test-on-ack-cluster |
| VpcID |
string |
No |
The VPC ID of the Self-managed MyBase cluster. |
vpc-xxxxxx |
| ClusterServices |
array |
No |
The services associated with instances in the Self-managed MyBase on ECS cluster. |
|
|
string |
No |
The services associated with instances in the Self-managed MyBase on ECS cluster. |
"Orchestrator3.2.6,Promethus2.49.1,Grafana10.2.3" |
|
| MyBaseEcsClass |
object |
No |
The instance parameters for the Self-managed MyBase on ECS cluster. |
|
| ChargeType |
string |
No |
The billing method. Valid values:
|
PrePaid |
| EcsClassCode |
string |
No |
The instance type. |
ecs.g7.large |
| Amount |
integer |
No |
The number of hosts to create. |
1 |
| Period |
integer |
No |
The subscription duration. Required when ChargeType is PrePaid. |
1 |
| PeriodType |
string |
No |
The unit of the subscription duration. Default value: Month. |
Month |
| SystemDiskSize |
integer |
No |
The size of the system disk. Unit: GB. |
40 |
| SystemDiskCategory |
string |
No |
The type of the system disk. |
cloud_essd |
| DataDiskSize |
integer |
No |
The size of the data disk. Unit: GB. |
40 |
| DataDiskCategory |
string |
No |
The type of the data disk. |
cloud_essd |
| DataDiskCount |
integer |
No |
The number of data disks. |
2 |
| AutoRenew |
boolean |
No |
Whether to enable auto-renewal. Default: false. |
false |
| Password |
string |
No |
The password of the host. |
*********** |
| KeyPairName |
string |
No |
The name of the key pair. |
test**** |
| SecurityGroupIds |
array |
No |
The security group IDs for the instance. |
|
|
string |
No |
The security group IDs for the instance. |
sg-uf64zn0tc9qakm2j**** |
|
| Tags |
array |
No |
The tags to add to the host. |
|
|
string |
No |
The tags to add to the host. |
{\"key1\":\"value1\"} |
|
| InternetMaxBandwidthOut |
integer |
No |
The maximum outbound public bandwidth. Unit: Mbit/s. Default: 0. Values greater than 0 automatically assign a public IP address. |
100 |
| InternetChargeType |
string |
No |
The metering method for network usage. Valid values:
|
PayByTraffic |
| DepolymentSetId |
string |
No |
The deployment set ID. |
**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| OrderId |
integer |
The order ID. |
102565235 |
| RequestId |
string |
The request ID. |
C860658E-68A6-46C1-AF6E-3AE7C4D32375 |
| ClusterName |
string |
The name of the cluster. |
ca-2ze0x527ovq3y**** |
| DedicateHostList |
object |
||
| DedicateHostList |
array<object> |
The created hosts. |
|
|
object |
|||
| DedicatedHostId |
string |
The ID of the created host. |
ch-bp108dki3wdl6**** |
Examples
Success response
JSON format
{
"OrderId": 102565235,
"RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D32375",
"ClusterName": "ca-2ze0x527ovq3y****",
"DedicateHostList": {
"DedicateHostList": [
{
"DedicatedHostId": " ch-bp108dki3wdl6****"
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The parameter is invalid. | |
| 400 | COMMODITY.INVALID_COMPONENT | Invalid component. | |
| 400 | InvalidAccountPassword.Format | The account password format is invalid. | The account password format is invalid. |
| 400 | InsufficientResourceCapacity | No host is available for the requested instance. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.