CreateLindormInstance-阿里云帮助中心

Create a Lindorm instance.

Operation description

To create an instance, you must specify at least one data engine. For example, to create a wide table engine, you must specify both the LindormNum (node count) and LindormSpec (node specification) parameters. For details on data engines and storage specifications, see How to select a data engine and How to select a storage specification.

Important If you do not specify any data engine parameters when you create an instance, the API call fails.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

lindorm:CreateLindormInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which to create the instance. You can call the DescribeRegions operation to query the latest region list.	cn-shanghai
ZoneId	string	Yes	The ID of the zone where you want to create the instance.	cn-shanghai-f
InstanceAlias	string	No	The name of the instance.	lindorm_test
InstanceStorage	string	No	The storage capacity of the instance, in GB.	480
PayType	string	Yes	The billing method of the instance. Valid values: PREPAY: Subscription. POSTPAY: Pay-As-You-Go.	POSTPAY
VPCId	string	Yes	The ID of the VPC where you want to create the instance.	vpc-bp1nme44gek34slfc****
VSwitchId	string	Yes	The ID of the VSwitch.	vsw-bp1e7clcw529l773d****
PricingCycle	string	No	The billing cycle for the Subscription instance. Valid values: Month Year Note This parameter is required if you set PayType to PREPAY.	Month
Duration	string	No	The subscription duration for the instance. Valid values: If PricingCycle is set to Month, the value can range from 1 to 9. If PricingCycle is set to Year, the value can range from 1 to 3. Note This parameter is required if you set PayType to PREPAY.	1
DiskCategory	string	Yes	The storage type of the instance. Valid values: cloud_efficiency: Efficiency cloud disk. cloud_ssd: Performance cloud disk. cloud_essd: Enhanced SSD (ESSD). cloud_essd_pl0: ESSD PL0. capacity_cloud_storage: Capacity-optimized cloud storage. (Not available for multi-zone instances.) local_ssd_pro: Local SSD. (Not available for multi-zone instances.) local_hdd_pro: Local HDD. (Not available for multi-zone instances.)	cloud_efficiency
CoreSpec	string	No	The node specification for an instance that uses local disks. If the storage type is local_ssd_pro, valid values include the following: Note that I3-family specifications are available only for Subscription instances. lindorm.i4.xlarge: 4 cores, 32 GB memory (I4). lindorm.i4.2xlarge: 8 cores, 64 GB memory (I4). lindorm.i4.4xlarge: 16 cores, 128 GB memory (I4). lindorm.i4.8xlarge: 32 cores, 256 GB memory (I4). lindorm.i3.xlarge: 4 cores, 32 GB memory (I3). lindorm.i3.2xlarge: 8 cores, 64 GB memory (I3). lindorm.i3.4xlarge: 16 cores, 128 GB memory (I3). lindorm.i3.8xlarge: 32 cores, 256 GB memory (I3). lindorm.i2.xlarge: 4 cores, 32 GB memory (I2). lindorm.i2.2xlarge: 8 cores, 64 GB memory (I2). lindorm.i2.4xlarge: 16 cores, 128 GB memory (I2). lindorm.i2.8xlarge: 32 cores, 256 GB memory (I2). If the storage type is local_hdd_pro, valid values include: lindorm.sd3c.3xlarge: 14 cores, 56 GB memory (D3C PRO). lindorm.sd3c.7xlarge: 28 cores, 112 GB memory (D3C PRO). lindorm.sd3c.14xlarge: 56 cores, 224 GB memory (D3C PRO). lindorm.d2c.6xlarge: 24 cores, 88 GB memory (D2C). lindorm.d2c.12xlarge: 48 cores, 176 GB memory (D2C). lindorm.d2c.24xlarge: 96 cores, 352 GB memory (D2C). lindorm.d2s.5xlarge: 20 cores, 88 GB memory (D2S). lindorm.d2s.10xlarge: 40 cores, 176 GB memory (D2S). lindorm.d1.2xlarge: 8 cores, 32 GB memory (D1NE). lindorm.d1.4xlarge: 16 cores, 64 GB memory (D1NE). lindorm.d1.6xlarge: 24 cores, 96 GB memory (D1NE).	lindorm.i2.xlarge
LindormNum	integer	No	The number of nodes in the wide table engine. For a single-zone instance, the value of this parameter ranges from 0 to 90. This parameter is required for multi-zone instances. For an instance that uses cloud disks, the value ranges from 4 to 400. For an instance that uses local disks, the value ranges from 6 to 400.	2
SolrSpec	string	No	The specification of the search engine nodes. Valid values: lindorm.g.xlarge: 4 cores, 16 GB memory (dedicated). lindorm.c.2xlarge: 8 cores, 16 GB memory (dedicated). lindorm.g.2xlarge: 8 cores, 32 GB memory (dedicated). lindorm.c.4xlarge: 16 cores, 32 GB memory (dedicated). lindorm.g.4xlarge: 16 cores, 64 GB memory (dedicated). lindorm.c.8xlarge: 32 cores, 64 GB memory (dedicated). lindorm.g.8xlarge: 32 cores, 128 GB memory (dedicated).	lindorm.g.xlarge
SolrNum	integer	No	The number of search engine nodes. The value of this parameter ranges from 0 to 60.	2
ColdStorage	integer	No	The cold storage capacity of the instance, in GB. The value of this parameter ranges from 800 to 1,000,000. If you do not specify this parameter, cold storage is not enabled.	800
TsdbSpec	string	No	The specification of the time series engine nodes. Valid values: lindorm.g.xlarge: 4 cores, 16 GB memory (dedicated). lindorm.g.2xlarge: 8 cores, 32 GB memory (dedicated). lindorm.g.4xlarge: 16 cores, 64 GB memory (dedicated). lindorm.g.8xlarge: 32 cores, 128 GB memory (dedicated).	lindorm.g.xlarge
TsdbNum	integer	No	The number of nodes in the time series engine. Valid values: For a Subscription instance, the value of this parameter ranges from 0 to 24. For a Pay-As-You-Go instance, the value of this parameter ranges from 0 to 32.	2
LindormSpec	string	No	The specification of the wide table engine nodes. Valid values: lindorm.g.xlarge: 4 cores, 16 GB memory (dedicated). lindorm.c.2xlarge: 8 cores, 16 GB memory (dedicated). lindorm.g.2xlarge: 8 cores, 32 GB memory (dedicated). lindorm.c.4xlarge: 16 cores, 32 GB memory (dedicated). lindorm.g.4xlarge: 16 cores, 64 GB memory (dedicated). lindorm.c.8xlarge: 32 cores, 64 GB memory (dedicated). lindorm.g.8xlarge: 32 cores, 128 GB memory (dedicated).	lindorm.c.xlarge
FilestoreNum	integer	No	The number of nodes in the file engine. Valid values: For a Subscription instance, the value of this parameter ranges from 0 to 60. For a Pay-As-You-Go instance, the value of this parameter ranges from 0 to 8.	2
FilestoreSpec	string	No	The specification of the file engine nodes. Valid values: lindorm.c.xlarge: 4 cores, 8 GB memory (standard).	lindorm.c.xlarge
StreamNum	integer	No	The number of nodes in the stream engine. The value of this parameter ranges from 0 to 60.	2
StreamSpec	string	No	The specification of the stream engine nodes. Valid values: lindorm.g.xlarge: 4 cores, 16 GB memory (dedicated). lindorm.c.2xlarge: 8 cores, 16 GB memory (dedicated). lindorm.g.2xlarge: 8 cores, 32 GB memory (dedicated). lindorm.c.4xlarge: 16 cores, 32 GB memory (dedicated). lindorm.g.4xlarge: 16 cores, 64 GB memory (dedicated). lindorm.c.8xlarge: 32 cores, 64 GB memory (dedicated). lindorm.g.8xlarge: 32 cores, 128 GB memory (dedicated).	lindorm.g.xlarge
ArchVersion	string	No	The deployment architecture of the instance. Valid values: 1.0: Single-zone deployment. 2.0: Multi-zone deployment. The default value is 1.0. To create a multi-zone instance, set this parameter to 2.0. This parameter is required for multi-zone instances.	2.0
PrimaryZoneId	string	No	The ID of the primary zone for the multi-zone instance. This parameter is required for multi-zone instances.	cn-shanghai-e
StandbyZoneId	string	No	The ID of the standby zone for the multi-zone instance. This parameter is required for multi-zone instances.	cn-shanghai-f
ArbiterZoneId	string	No	The ID of the arbiter zone for the multi-zone instance. This parameter is required for multi-zone instances.	cn-shanghai-g
MultiZoneCombination	string	No	The combination of zones for the multi-zone instance. For a list of supported combinations, refer to the instance purchase page. ap-southeast-5abc-aliyun: Indonesia (Jakarta) A+B+C. cn-hangzhou-ehi-aliyun: China (Hangzhou) E+H+I. cn-beijing-acd-aliyun: China (Beijing) A+C+D. ap-southeast-1-abc-aliyun: Singapore A+B+C. cn-zhangjiakou-abc-aliyun: China (Zhangjiakou) A+B+C. cn-shanghai-efg-aliyun: China (Shanghai) E+F+G. cn-shanghai-abd-aliyun: China (Shanghai) A+B+D. cn-hangzhou-bef-aliyun: China (Hangzhou) B+E+F. cn-hangzhou-bce-aliyun: China (Hangzhou) B+C+E. cn-beijing-fgh-aliyun: China (Beijing) F+G+H. cn-shenzhen-abc-aliyun: China (Shenzhen) A+B+C. This parameter is required for multi-zone instances.	cn-shanghai-efg-aliyun
PrimaryVSwitchId	string	No	The ID of the VSwitch for the primary zone of the multi-zone instance. The VSwitch must be in the zone specified by `PrimaryZoneId`. This parameter is required for multi-zone instances.	vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchId	string	No	The ID of the VSwitch for the standby zone of the multi-zone instance. The VSwitch must be in the zone specified by `StandbyZoneId`. This parameter is required for multi-zone instances.	vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchId	string	No	The ID of the VSwitch for the arbiter zone of the multi-zone instance. The VSwitch must be in the zone specified by `ArbiterZoneId`. This parameter is required for multi-zone instances.	vsw-uf6664pqjawb87k36****
CoreSingleStorage	integer	No	The storage capacity of a single core node in the multi-zone instance. Unit: GB. The value of this parameter ranges from 400 to 64,000. This parameter is required for multi-zone instances.	400
LogDiskCategory	string	No	The storage type of the log nodes for the multi-zone instance. Valid values: cloud_efficiency: Efficiency cloud disk. cloud_ssd: Performance cloud disk. This parameter is required for multi-zone instances.	cloud_ssd
LogSpec	string	No	The specification of the log nodes for the multi-zone instance. Valid values: lindorm.sn1.large: 4 cores, 8 GB memory (dedicated). lindorm.sn1.2xlarge: 8 cores, 16 GB memory (dedicated). This parameter is required for multi-zone instances.	lindorm.sn1.large
LogNum	integer	No	The number of log nodes for the multi-zone instance. The value of this parameter ranges from 4 to 400. This parameter is required for multi-zone instances.	4
LogSingleStorage	integer	No	The storage capacity of a single log node in the multi-zone instance. Unit: GB. The value of this parameter ranges from 400 to 64,000. This parameter is required for multi-zone instances.	400
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2i6weeb4nfii
AutoRenewal	boolean	No	Specifies whether to enable auto-renewal for the Subscription instance. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. Default value: false. Note This parameter takes effect only when the PayType parameter is set to PREPAY.	false
AutoRenewDuration	string	No	The auto-renewal duration, in months. The value of this parameter ranges from 1 to 12. Note This parameter takes effect only when AutoRenewal is set to true.	1
LtsSpec	string	No	The specification of the LTS engine nodes. Valid values: lindorm.c.xlarge: 4 cores, 8 GB memory (dedicated). lindorm.g.xlarge: 4 cores, 16 GB memory (dedicated). lindorm.c.2xlarge: 8 cores, 16 GB memory (dedicated). lindorm.g.2xlarge: 8 cores, 32 GB memory (dedicated). lindorm.c.4xlarge: 16 cores, 32 GB memory (dedicated). lindorm.g.4xlarge: 16 cores, 64 GB memory (dedicated). lindorm.c.8xlarge: 32 cores, 64 GB memory (dedicated). lindorm.g.8xlarge: 32 cores, 128 GB memory (dedicated).	lindorm.g.xlarge
LtsNum	string	No	The number of nodes in the LTS engine. The value of this parameter ranges from 0 to 60.	2
Tag	array<object>	No	The tags to add to the instance. You can add up to 20 tags.
	object	No	The list of tags.
Key	string	No	The key of a tag. Note You can specify the keys of multiple tags. For example, `Tag.1.Key` specifies the key of the first tag and `Tag.2.Key` specifies the key of the second tag.	test
Value	string	No	The value of a tag. Note You can specify the values of multiple tags. For example, `Tag.1.Value` specifies the value of the first tag and `Tag.2.Value` specifies the value of the second tag.	value

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	93BE8227-3406-4D7A-883D-9A421D42****
InstanceId	string	The ID of the created instance.	ld-bp1o3y0yme2i2****
OrderId	integer	The order ID.	111111111111111
AccessDeniedDetail	string	Details about the access denial.	{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "RequestId": "93BE8227-3406-4D7A-883D-9A421D42****",
  "InstanceId": "ld-bp1o3y0yme2i2****",
  "OrderId": 111111111111111,
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
400	LindormErrorCode.%s	%s.	%s.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.