All Products
Search

This Product

    Lindorm:CreateLindormInstance

    Document Center

    Lindorm:CreateLindormInstance

    Last Updated:Oct 27, 2025

    Creates a Lindorm instance.

    Operation description

    Select at least one data engine when you create an instance. For example, to create an instance that uses LindormTable, specify both the LindormNum and LindormSpec parameters. For more information about data engines and storage specifications, see Select a data engine and Select storage specifications.

    Important If you do not specify the parameters for a data engine when creating 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The ID of the region where you want to create the instance. To query the available regions, call the DescribeRegions operation.

    cn-shanghai
    ZoneId

    string

    Yes

    The ID of the zone for 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:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    POSTPAY
    VPCId

    string

    Yes

    The ID of the virtual private cloud (VPC) for the instance.

    vpc-bp1nme44gek34slfc****
    VSwitchId

    string

    Yes

    The ID of the vSwitch.

    vsw-bp1e7clcw529l773d****
    PricingCycle

    string

    No

    The unit of the subscription duration. Valid values:

    • Month: The unit is month.

    • Year: The unit is year.

    Note

    This parameter is available and required only when PayType is set to PREPAY.

    Month
    Duration

    string

    No

    The subscription duration of the instance. Valid values:

    • If PricingCycle is set to Month, the valid values are 1 to 9.

    • If PricingCycle is set to Year, the valid values are 1 to 3.

    Note

    This parameter is available and required only when PayType is set to PREPAY.

    1
    DiskCategory

    string

    Yes

    The storage class of the instance. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: performance cloud storage.

    • cloud_essd: enhanced SSD (ESSD) cloud storage.

    • cloud_essd_pl0: ESSD PL0 cloud storage.

    • capacity_cloud_storage: capacity-optimized cloud storage. This storage class is not supported for multi-zone instances.

    • local_ssd_pro: local SSD. This storage class is not supported for multi-zone instances.

    • local_hdd_pro: local HDD. This storage class is not supported for multi-zone instances.

    cloud_efficiency
    CoreSpec

    string

    No

    The node specifications of the instance that uses local disks.

    If the storage class of the instance is local_ssd_pro, valid values for this parameter are as follows. The I3 instance family is available only for subscription instances.

    • lindorm.i4.xlarge: 4 cores, 32 GB (I4).

    • lindorm.i4.2xlarge: 8 cores, 64 GB (I4).

    • lindorm.i4.4xlarge: 16 cores, 128 GB (I4).

    • lindorm.i4.8xlarge: 32 cores, 256 GB (I4).

    • lindorm.i3.xlarge: 4 cores, 32 GB (I3).

    • lindorm.i3.2xlarge: 8 cores, 64 GB (I3).

    • lindorm.i3.4xlarge: 16 cores, 128 GB (I3).

    • lindorm.i3.8xlarge: 32 cores, 256 GB (I3).

    • lindorm.i2.xlarge: 4 cores, 32 GB (I2).

    • lindorm.i2.2xlarge: 8 cores, 64 GB (I2).

    • lindorm.i2.4xlarge: 16 cores, 128 GB (I2).

    • lindorm.i2.8xlarge: 32 cores, 256 GB (I2).

    If the storage class of the instance is local_hdd_pro, valid values for this parameter are:

    • lindorm.sd3c.3xlarge: 14 cores, 56 GB (D3C PRO).

    • lindorm.sd3c.7xlarge: 28 cores, 112 GB (D3C PRO).

    • lindorm.sd3c.14xlarge: 56 cores, 224 GB (D3C PRO).

    • lindorm.d2c.6xlarge: 24 cores, 88 GB (D2C).

    • lindorm.d2c.12xlarge: 48 cores, 176 GB (D2C).

    • lindorm.d2c.24xlarge: 96 cores, 352 GB (D2C).

    • lindorm.d2s.5xlarge: 20 cores, 88 GB (D2S).

    • lindorm.d2s.10xlarge: 40 cores, 176 GB (D2S).

    • lindorm.d1.2xlarge: 8 cores, 32 GB (D1NE).

    • lindorm.d1.4xlarge: 16 cores, 64 GB (D1NE).

    • lindorm.d1.6xlarge: 24 cores, 96 GB (D1NE).

    lindorm.i2.xlarge
    LindormNum

    integer

    No

    The number of LindormTable nodes in the instance.

    For a single-zone instance, the valid values are 0 to 90.

    This parameter is required if you create a multi-zone instance. For an instance that uses cloud disks, the valid values are 4 to 400. For an instance that uses local disks, the valid values are 6 to 400.

    2
    SolrSpec

    string

    No

    The node specifications for the search engine. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated).

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated).

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated).

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated).

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated).

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated).

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated).

    lindorm.g.xlarge
    SolrNum

    integer

    No

    The number of search engine nodes in the instance. Valid values: 0 to 60.

    2
    ColdStorage

    integer

    No

    The storage capacity of the capacity-optimized cloud storage for the instance. Unit: GB. If you do not specify this parameter, capacity-optimized cloud storage is not enabled for the instance. Valid values: 800 to 1000000.

    800
    TsdbSpec

    string

    No

    The node specifications for LindormTSDB. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated).

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated).

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated).

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated).

    lindorm.g.xlarge
    TsdbNum

    integer

    No

    The number of LindormTSDB nodes in the instance. Valid values:

    • If the billing method of the instance is PREPAY, the valid values are 0 to 24.

    • If the billing method of the instance is POSTPAY, the valid values are 0 to 32.

    2
    LindormSpec

    string

    No

    The node specifications for LindormTable. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated).

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated).

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated).

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated).

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated).

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated).

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated).

    lindorm.c.xlarge
    FilestoreNum

    integer

    No

    The number of file engine nodes in the instance. Valid values:

    • If the billing method of the instance is PREPAY, the valid values are 0 to 60.

    • If the billing method of the instance is POSTPAY, the valid values are 0 to 8.

    2
    FilestoreSpec

    string

    No

    The node specifications for the file engine. Valid values:

    • lindorm.c.xlarge: 4 cores, 8 GB (Standard).

    lindorm.c.xlarge
    StreamNum

    integer

    No

    The number of stream engine nodes in the instance. Valid values: 0 to 60.

    2
    StreamSpec

    string

    No

    The node specifications for the stream engine. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated).

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated).

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated).

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated).

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated).

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated).

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated).

    lindorm.g.xlarge
    ArchVersion

    string

    No

    The deployment architecture. Valid values:

    • 1.0: single zone.

    • 2.0: multi-zone.

    The default value 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

    The ID of the primary zone for the multi-zone instance. This parameter is required if you want to create a multi-zone instance.

    cn-shanghai-e
    StandbyZoneId

    string

    No

    The ID of the secondary zone for the multi-zone instance. This parameter is required if you want to create a multi-zone instance.

    cn-shanghai-f
    ArbiterZoneId

    string

    No

    The ID of the arbiter zone for the multi-zone instance. This parameter is required if you want to create a multi-zone instance.

    cn-shanghai-g
    MultiZoneCombination

    string

    No

    The combination of zones for the multi-zone instance. To view the supported zone combinations, go to the instance buy 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 if you want to create a multi-zone instance.

    cn-shanghai-efg-aliyun
    PrimaryVSwitchId

    string

    No

    The ID of the vSwitch in the primary zone for the multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId. This parameter is required if you want to create a multi-zone instance.

    vsw-uf6fdqa7c0pipnqzq****
    StandbyVSwitchId

    string

    No

    The ID of the vSwitch in the secondary zone for the multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId. This parameter is required if you want to create a multi-zone instance.

    vsw-2zec0kcn08cgdtr6****
    ArbiterVSwitchId

    string

    No

    The ID of the vSwitch in the arbiter zone for the multi-zone instance. The vSwitch must be in the zone specified by ArbiterZoneId. This parameter is required if you want to create a multi-zone instance.

    vsw-uf6664pqjawb87k36****
    CoreSingleStorage

    integer

    No

    The storage capacity of a single core node in the multi-zone instance. Unit: GB. Valid values: 400 to 64000. This parameter is required if you want to create a multi-zone instance.

    400
    LogDiskCategory

    string

    No

    The disk type of the log nodes in the multi-zone instance. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: performance cloud storage.

    This parameter is required if you want to create a multi-zone instance.

    cloud_ssd
    LogSpec

    string

    No

    The specifications of the log nodes in the multi-zone instance. Valid values:

    • lindorm.sn1.large: 4 cores, 8 GB (Dedicated).

    • lindorm.sn1.2xlarge: 8 cores, 16 GB (Dedicated).

    This parameter is required if you want to create a multi-zone instance.

    lindorm.sn1.large
    LogNum

    integer

    No

    The number of log nodes in the multi-zone instance. 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 a single log node in the multi-zone instance. Unit: GB. Valid values: 400 to 64000. This parameter is required if you want to create a multi-zone instance.

    400
    ResourceGroupId

    string

    No

    The ID of the resource group.

    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 PayType 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 AutoRenewal is set to true.

    1
    LtsSpec

    string

    No

    The node specifications for the LTS engine. Valid values:

    • lindorm.c.xlarge: 4 cores, 8 GB (Dedicated).

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated).

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated).

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated).

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated).

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated).

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated).

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated).

    lindorm.g.xlarge
    LtsNum

    string

    No

    The number of LTS engine nodes in the instance. Valid values: 0 to 60.

    2
    Tag

    array<object>

    No

    The tags.

    object

    No

    The tags.

    Key

    string

    No

    The key of the tag. You can specify up to 20 tags.

    Note

    You can pass keys for multiple tags. For example, the Key in the first pair specifies the key for the first tag. The Key in the second pair specifies the key for the second tag.

    test
    Value

    string

    No

    The value of the tag. You can specify up to 20 tags.

    Note

    You can pass values for multiple tags. For example, the Value in the first pair specifies the value for the first tag. The Value in the second pair specifies the value for the second tag.

    value

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    93BE8227-3406-4D7A-883D-9A421D42****
    InstanceId

    string

    The ID of the created instance.

    ld-bp1o3y0yme2i2****
    OrderId

    integer

    The ID of the order.

    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.