CreateLindormInstance - Lindorm - Alibaba Cloud Documentation Center

Creates a Lindorm instance.

Operation description

You must select at least one engine when you create a Lindorm instance. For more information about how to select the storage type and engine type when you create a Lindorm instance, see Select engine types and Select storage types.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
lindorm:CreateLindormInstance	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which you want to create the instance. You can call the DescribeRegions operation to query the region in which you can create the instance.	cn-shanghai
ZoneId	string	Yes	The ID of the zone in which you want to create the instance.	cn-shanghai-f
InstanceAlias	string	Yes	The name of the instance that you want to create.	lindorm_test
InstanceStorage	string	Yes	The storage capacity of the instance you want to create. Unit: GB.	480
PayType	string	Yes	The billing method of the instance you want to create. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	POSTPAY
VPCId	string	Yes	The ID of the VPC in which you want to create the instance.	vpc-bp1nme44gek34slfc****
VSwitchId	string	Yes	The ID of the vSwitch to which you want the instance to connect.	vsw-bp1e7clcw529l773d****
PricingCycle	string	No	The period based on which you are charged for the instance. Valid values: Month: You are charged for the instance on a monthly basis. Year: You are charged for the instance on a yearly basis. Note This parameter is available and required when the PayType parameter is set to PREPAY.	Month
Duration	string	No	The subscription period of the instance. The valid values of this parameter depend on the value of the PricingCycle parameter. If PricingCycle is set to Month, set this parameter to an integer that ranges from 1 to 9. If PricingCycle is set to Year, set this parameter to an integer that ranges from 1 to 3. Note This parameter is available and required when the PayType parameter is set to PREPAY.	1
DiskCategory	string	Yes	The storage type of the instance. Valid values: cloud_efficiency: This instance uses the Standard type of storage. cloud_ssd: This instance uses the Performance type of storage. capacity_cloud_storage: This instance uses the Capacity type of storage. local_ssd_pro: This instance uses local SSDs. local_hdd_pro: This instance uses local HDDs.	cloud_efficiency
CoreSpec	string	No	The specification of the nodes in the instance if you set DiskCategory to local_ssd_pro or local_hdd_pro. When DiskCategory is set to local_ssd_pro, you can set this parameter to the following values: lindorm.i2.xlarge: Each node has 4 dedicated CPU cores and 32 GB of dedicated memory. lindorm.i2.2xlarge: Each node has 8 dedicated CPU cores and 64 GB of dedicated memory. lindorm.i2.4xlarge: Each node has 16 dedicated CPU cores and 128 GB of dedicated memory. lindorm.i2.8xlarge: Each node has 32 dedicated CPU cores and 256 GB of dedicated memory. When DiskCategory is set to local_hdd_pro, you can set this parameter to the following values: lindorm.d1.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.d1.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.d1.6xlarge: Each node has 24 dedicated CPU cores and 96 GB of dedicated memory.	lindorm.i2.xlarge
LindormNum	integer	No	The number of LindormTable nodes in the instance. The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 90. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 400. This parameter is required if you want to create a multi-zone instance. The valid values of this parameter range from 4 to 400 if you want to create a multi-zone instance.	2
SolrSpec	string	No	The specification of the LindormSearch nodes in the instance. Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.	lindorm.g.xlarge
SolrNum	integer	No	The number of LindormSearch nodes in the instance. Valid values: integers from 0 to 60.	2
ColdStorage	integer	No	The cold storage capacity of the instance. By default, if you leave this parameter unspecified, cold storage is not enabled for the instance. Unit: GB. Valid values: 800 to 1000000.	800
TsdbSpec	string	No	The specification of the LindormTSDB nodes in the instance. Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.	lindorm.g.xlarge
TsdbNum	integer	No	The number of the LindormTSDB nodes in the instance. The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 24. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 32.	2
LindormSpec	string	No	The specification of LindormTable nodes in the instance. Valid values: lindorm.c.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.c.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. lindorm.c.4xlarge: Each node has 16 dedicated CPU cores and 32 GB of dedicated memory. lindorm.c.8xlarge: Each node has 32 dedicated CPU cores and 64 GB of dedicated memory.	lindorm.c.xlarge
FilestoreNum	integer	No	The number of LindormDFS nodes in the instance. The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 60. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 8.	2
FilestoreSpec	string	No	The specification of LindormDFS nodes in the instance. Set the value of this parameter to lindorm.c.xlarge, which indicates that each node has 4 dedicated CPU cores and 8 GB of dedicated memory.	lindorm.c.xlarge
StreamNum	integer	No	The number of LindormStream nodes in the instance. Valid values: integers from 0 to 60.	2
StreamSpec	string	No	The specification of the LindormStream nodes in the instance. Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.	lindorm.g.xlarge
ArchVersion	string	No	The architecture of the instance. Valid values: 1.0: The instance that you want to create is a single-zone instance. 2.0: The instance that you want to create is a multi-zone instance. By default, the value of this parameter is 1.0. To create a multi-zone instance, set this parameter to 2.0. This parameter is required if you want to create a multi-zone instance.	2.0
PrimaryZoneId	string	No	Multi-zone instance, availability zone ID of the primary zone. This parameter is required if you need to create a multi-zone instance.	cn-shanghai-e
StandbyZoneId	string	No	The ID of the secondary zone of the instance. This parameter is required if you want to create a multi-zone instance.	cn-shanghai-f
ArbiterZoneId	string	No	The ID of the zone for the coordinate node of the instance. This parameter is required if you want to create a multi-zone instance.	cn-shanghai-g
MultiZoneCombination	string	No	The combinations of zones that are available for the multi-zone instance. You can go to the purchase page of Lindorm to view the supported zone combinations. ap-southeast-5abc-aliyun: Zone A+B+C in the Indonesia (Jakarta) region. cn-hangzhou-ehi-aliyun: Zone E+H+I in the China (Hangzhou) region. cn-beijing-acd-aliyun: Zone A+C+D in the China (Beijing) region. ap-southeast-1-abc-aliyun: Zone A+B+C in the Singapore region. cn-zhangjiakou-abc-aliyun: Zone A+B+C in the China (Zhangjiakou) region. cn-shanghai-efg-aliyun: Zone E+F+G in the China (Shanghai) region. cn-shanghai-abd-aliyun: Zone A+B+D in the China (Shanghai) region. cn-hangzhou-bef-aliyun: Zone B+E+F in the China (Hangzhou) region. cn-hangzhou-bce-aliyun: Zone B+C+E in the China (Hangzhou) region. cn-beijing-fgh-aliyun: Zone F+G+H in the China (Beijing) region. cn-shenzhen-abc-aliyun: Zone A+B+C in the China (Shenzhen) region. This parameter is required if you want to create a multi-zone instance.	cn-shanghai-efg-aliyun
PrimaryVSwitchId	string	No	The ID of the vSwitch that is specified for the secondary zone of the instance. The vSwitch must be deployed in the zone specified by the StandbyZoneId parameter. This parameter is required if you want to create a multi-zone instance.	vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchId	string	No	The ID of the vSwitch that is specified for the secondary zone of the instance. The vSwitch must be deployed in the zone specified by the StandbyZoneId parameter. This parameter is required if you want to create a multi-zone instance.	vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchId	string	No	The ID of the vSwitch that is specified for the zone for the coordinate node of the instance. The vSwitch must be deployed in the zone specified by the ArbiterZoneId parameter. This parameter is required if you want to create a multi-zone instance.	vsw-uf6664pqjawb87k36****
CoreSingleStorage	integer	No	The storage capacity of the disk of a single core node. Valid values: 400 to 64000. Unit: GB. This parameter is required if you want to create a multi-zone instance.	400
LogDiskCategory	string	No	The disk type of the log nodes. Valid values: cloud_efficiency: This instance uses the Standard type of storage. cloud_ssd: This instance uses the Performance type of storage. This parameter is required if you want to create a multi-zone instance.	cloud_ssd
LogSpec	string	No	The type of the log nodes. Valid values: lindorm.sn1.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.sn1.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. This parameter is required if you want to create a multi-zone instance.	lindorm.sn1.large
LogNum	integer	No	The number of the log nodes. Valid values: 4 to 400. This parameter is required if you want to create a multi-zone instance.	4
LogSingleStorage	integer	No	The storage capacity of the disk of a single log node. Valid values: 400 to 64000. Unit: GB. This parameter is required if you want to create a multi-zone instance.	400
ResourceGroupId	string	No	The ID of the resource group to which the Lindorm instance belongs.	rg-aek2i6weeb4nfii
AutoRenewal	boolean	No	Specifies whether to enable auto-renewal for the instance. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false. Note This parameter is available only when the PayType parameter is set to PREPAY.	false
AutoRenewDuration	string	No	The auto-renewal duration. Unit: month. Valid values: 1 to 12. Note This parameter is available only when the AutoRenewal parameter is set to true.	1
LtsSpec	string	No	Specification of the LTS engine nodes for the instance. Values: lindorm.c.xlarge: Represents 4 cores and 8GB (dedicated specification). - lindorm.g.xlarge: Represents 4 cores and 16GB (dedicated specification). - lindorm.c.2xlarge: Represents 8 cores and 16GB (dedicated specification). - lindorm.g.2xlarge: Represents 8 cores and 32GB (dedicated specification). - lindorm.c.4xlarge: Represents 16 cores and 32GB (dedicated specification). - lindorm.g.4xlarge: Represents 16 cores and 64GB (dedicated specification). - lindorm.c.8xlarge: Represents 32 cores and 64GB (dedicated specification). - lindorm.g.8xlarge: Represents 32 cores and 128GB (dedicated specification).	lindorm.g.xlarge
LtsNum	string	No	The number of LTS engine nodes for the instance, with values ranging from 0 to 60.	2

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	93BE8227-3406-4D7A-883D-9A421D42****
InstanceId	string	The ID of the Lindorm instance that is created.	ld-bp1o3y0yme2i2****
OrderId	long	The ID of the order.	111111111111111

Examples

Sample success responses

JSONformat

{
  "RequestId": "93BE8227-3406-4D7A-883D-9A421D42****",
  "InstanceId": "ld-bp1o3y0yme2i2****",
  "OrderId": 111111111111111
}

Error codes

HTTP status code	Error code	Error message
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.

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

Change history

Change time	Summary of changes	Operation
2024-05-15	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-12-12	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-03-07	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-11-14	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-10-14	The Error code has changed. The request parameters of the API has changed	View Change Details