CreateDedicatedHost - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Creates hosts in a dedicated cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the dedicated cluster.	cn-hangzhou
DedicatedHostGroupId	string	Yes	The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID. Note The database engine of the host is the same as the database engine of the cluster.	dhg-6w7q18iwt5jo****
ZoneId	string	Yes	The zone ID. You can call the DescribeRegions operation to query the most recent zone list.	cn-hangzhou-i
VSwitchId	string	Yes	The vSwitch ID. You can log on to the Virtual Private Cloud (VPC) console to view the vSwitch ID.	vsw-bp133c8ifzxd3iv6q****
HostClass	string	Yes	The instance type of the host. For information about the host instance types supported by different database engines, see 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: Year Month	Month
UsedTime	string	No	The subscription duration of the host. Valid values when Period is set to Year: 1 to 5.** Valid values when Period is set to Month**: 1 to 9.	1
ClientToken	string	Yes	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzSBZH8****
AutoRenew	string	No	Specifies whether to enable the auto-renewal feature. Valid values: true false Note If you do not specify this parameter, the default value false is used.	false
ImageCategory	string	No	The image of the host. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition. WindowsWithMssqlStdLicense: SQL Server Standard Edition. WindowsWithMssqlEntLicense: SQL Server Enterprise Edition. WindowsWithMssqlWebLicense: SQL Server Web Edition. AliLinux: other images. Note When you create a host that runs SQL Server, you must specify a host image.	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. The password must be 8 to 30 characters in length. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password can contain the following special characters: () \ ` ~ ! @ # $ % ^ & * - _ + = \| { } [ ] : ; ' < > , . ? /	Test123456
HostStorageType	string	No	The disk type of the host. This parameter takes effect only for dedicated clusters that run Tair. Valid values: cloud_essd: PL1 enhanced SSD (ESSD). cloud_essd0: PL0 ESSD.	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 1024 1536 2048 2560 3072 3584 4096	512

Response parameters

Parameter	Type	Description	Example
	object
OrderId	long	The order ID.	102565235
RequestId	string	The request ID.	C860658E-68A6-46C1-AF6E-3AE7C4D32375
DedicateHostList	object []	The created hosts.
DedicatedHostId	string	The host ID.	ch-bp108dki3wdl6****

Examples

Sample success responses

JSONformat

{
  "OrderId": 102565235,
  "RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D32375",
  "DedicateHostList": {
    "DedicateHostList": [
      {
        "DedicatedHostId": " ch-bp108dki3wdl6****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter is invalid.	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.	No host is available for the requested instance.

For a list of error codes, visit the Service error codes.