Creates a Lindorm instance.
Operation description
When you create an instance, you must select at least one data engine. For example, to create a LindormTable engine, you must specify both the LindormNum (number of LindormTable engine nodes) and LindormSpec (LindormTable engine node specifications) parameters. For more information about data engines and storage specifications, see How to select a data engine and How to select a storage specification.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
lindorm:CreateLindormInstance |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the instance. You can call DescribeRegions to query available regions. Use this parameter to specify the region in which to create the instance. |
cn-shanghai |
| ZoneId |
string |
Yes |
The zone ID of the instance. |
cn-shanghai-f |
| InstanceAlias |
string |
No |
The name of the instance. |
lindorm_test |
| InstanceStorage |
string |
No |
The storage capacity of the instance. Unit: GB. |
480 |
| PayType |
string |
Yes |
The billing method of the instance. Valid values:
|
POSTPAY |
| VPCId |
string |
Yes |
The VPC ID of the instance. |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
Yes |
The vSwitch ID. |
vsw-bp1e7clcw529l773d**** |
| PricingCycle |
string |
No |
The billing cycle of the instance. Valid values:
Note
This parameter is available and required when PayType is set to PREPAY. |
Month |
| Duration |
string |
No |
The subscription duration of the instance. Valid values:
Note
This parameter is available and required when PayType is set to PREPAY. |
1 |
| DiskCategory |
string |
Yes |
The storage type of the instance. Valid values:
|
cloud_efficiency |
| CoreSpec |
string |
No |
The node specifications for local disk type of the instance. When the local storage type is local_ssd_pro, valid values are as follows. I3 instance types currently support only subscription:
When the local storage type is local_hdd_pro, valid values are as follows:
|
lindorm.i2.xlarge |
| LindormNum |
integer |
No |
The number of LindormTable engine nodes of the instance. To create a single-zone instance, valid values are 0 to 90. To create a multi-zone instance, this parameter is required. For instances with non-local disk storage types, valid values are 4 to 400. For instances with local disk storage types, valid values are 6 to 400. |
2 |
| SolrSpec |
string |
No |
The search index engine node specifications of the instance. Valid values:
|
lindorm.g.xlarge |
| SolrNum |
integer |
No |
The number of search index engine nodes of the instance. Valid values: 0 to 60. |
2 |
| ColdStorage |
integer |
No |
The capacity cloud storage capacity of the instance. Unit: GB. If this parameter is not specified, capacity cloud storage is not enabled. Valid values: 800 to 1000000. |
800 |
| TsdbSpec |
string |
No |
The LindormTSDB engine node specifications of the instance. Valid values:
|
lindorm.g.xlarge |
| TsdbNum |
integer |
No |
The number of LindormTSDB engine nodes of the instance. Valid values:
|
2 |
| LindormSpec |
string |
No |
The LindormTable engine node specifications of the instance. Valid values:
|
lindorm.g.4xlarge |
| FilestoreNum |
integer |
No |
The number of file engine nodes of the instance. Valid values:
|
2 |
| FilestoreSpec |
string |
No |
The file engine node specifications of the instance. Valid values:
|
lindorm.c.xlarge |
| StreamNum |
integer |
No |
The number of stream engine nodes of the instance. Valid values: 0 to 60. |
2 |
| StreamSpec |
string |
No |
The stream engine node specifications of the instance. Valid values:
|
lindorm.g.xlarge |
| ArchVersion |
string |
No |
The deployment architecture. Valid values:
If this parameter is not specified, the default value is 1.0. To create a multi-zone instance, set this parameter to 2.0. To create a multi-zone instance, this parameter is required. |
2.0 |
| PrimaryZoneId |
string |
No |
The zone ID of the primary zone for a multi-zone instance. To create a multi-zone instance, this parameter is required. |
cn-shanghai-e |
| StandbyZoneId |
string |
No |
The zone ID of the secondary zone for a multi-zone instance. To create a multi-zone instance, this parameter is required. |
cn-shanghai-f |
| ArbiterZoneId |
string |
No |
The zone ID of the arbiter zone for a multi-zone instance. To create a multi-zone instance, this parameter is required. |
cn-shanghai-g |
| MultiZoneCombination |
string |
No |
The multi-zone combination. You can check the supported zone combinations on the buy page.
To create a multi-zone instance, this parameter is required. |
cn-shanghai-efg-aliyun |
| PrimaryVSwitchId |
string |
No |
The vSwitch ID of the primary zone for a multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId. To create a multi-zone instance, this parameter is required. |
vsw-uf6fdqa7c0pipnqzq**** |
| StandbyVSwitchId |
string |
No |
The vSwitch ID of the secondary zone for a multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId. To create a multi-zone instance, this parameter is required. |
vsw-2zec0kcn08cgdtr6**** |
| ArbiterVSwitchId |
string |
No |
The vSwitch ID of the arbiter zone for a multi-zone instance. The vSwitch must be in the zone specified by ArbiterZoneId. To create a multi-zone instance, this parameter is required. |
vsw-uf6664pqjawb87k36**** |
| CoreSingleStorage |
integer |
No |
The storage capacity per core node for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. To create a multi-zone instance, this parameter is required. |
400 |
| LogDiskCategory |
string |
No |
The disk type of log nodes for a multi-zone instance. Valid values:
To create a multi-zone instance, this parameter is required. |
cloud_ssd |
| LogSpec |
string |
No |
The log node specifications for a multi-zone instance. Valid values:
To create a multi-zone instance, this parameter is required and active. |
lindorm.sn1.large |
| LogNum |
integer |
No |
The number of log nodes for a multi-zone instance. Valid values: 4 to 400. To create a multi-zone instance, this parameter is required. |
4 |
| LogSingleStorage |
integer |
No |
The storage capacity per log node for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. To create a multi-zone instance, this parameter is required. |
400 |
| ResourceGroupId |
string |
No |
The resource group ID. |
rg-aek2i6weeb4nfii |
| AutoRenewal |
boolean |
No |
Specifies whether to enable auto-renewal for the instance. Valid values:
Default value: false. Note
This parameter takes effect only when PayType is set to PREPAY (subscription). |
false |
| AutoRenewDuration |
string |
No |
The auto-renewal duration. Unit: months. Valid values: 1 to 12. Note
This parameter takes effect only when AutoRenewal is set to true. |
1 |
| LtsSpec |
string |
No |
The LTS engine node specifications of the instance. Valid values:
|
lindorm.g.xlarge |
| LtsNum |
string |
No |
The number of LTS engine nodes of the instance. Valid values: 0 to 60. |
2 |
| Tag |
array<object> |
No |
The list of tags. |
|
|
object |
No |
The list of tags. |
||
| Key |
string |
No |
The tag key. Valid values of N: 1 to 20. Note
You can specify multiple tag keys. For example, the Key in the first pair specifies the first tag key, and the Key in the second pair specifies the second tag key. |
test |
| Value |
string |
No |
The tag value. Valid values of N: 1 to 20. Note
You can specify multiple tag values. For example, the Value in the first pair specifies the first tag value, and the Value in the second pair specifies the second tag value. |
value |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
93BE8227-3406-4D7A-883D-9A421D42**** |
| InstanceId |
string |
The instance ID. |
ld-bp1o3y0yme2i2**** |
| OrderId |
integer |
The order ID. |
111111111111111 |
| AccessDeniedDetail |
string |
The 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.