All Products
Search

This Product

    Lindorm:GetLindormInstance

    Document Center

    Lindorm:GetLindormInstance

    Last Updated:Oct 27, 2025

    Retrieves the details of a Lindorm instance, including the instance type, billing method, and the virtual private cloud (VPC) in which the instance is deployed.

    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
    InstanceId

    string

    Yes

    The ID of the instance. Call the GetLindormInstanceList operation to obtain the instance ID.

    ld-bp1o3y0yme2i2****

    Response elements

    Element

    Type

    Description

    Example

    object

    VpcId

    string

    The ID of the virtual private cloud (VPC) to which the instance belongs.

    vpc-bp1n3i15v90el48nx****
    VswitchId

    string

    The vSwitch ID.

    vsw-bp1vbjzmod9q3l9eo****
    CreateTime

    string

    The time when the instance was created. The time is in the yyyy-MM-dd HH:mm:ss format.

    2021-07-26 17:10:26
    PayType

    string

    The billing method of the instance. Valid values:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    POSTPAY
    NetworkType

    string

    The network type of the instance.

    vpc
    ServiceType

    string

    The type of the instance. Valid values:

    • lindorm: a single-zone Lindorm instance.

    • lindorm_multizone: a multi-zone Lindorm instance.

    • serverless_lindorm: a Lindorm Serverless instance.

    • lindorm_standalone: a standalone Lindorm instance.

    • lts: a Lindorm Tunnel Service (LTS) instance.

    lindorm
    EnableKms

    boolean

    Indicates whether Key Management Service (KMS) is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    EnableStoreTDE

    boolean

    Indicates whether transparent data encryption (TDE) is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    DiskUsage

    string

    The disk usage.

    0.0%
    DiskCategory

    string

    The storage type 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.

    • local_ssd_pro: local SSD.

    • local_hdd_pro: local HDD.

    cloud_efficiency
    RequestId

    string

    The request ID.

    633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
    ColdStorage

    integer

    The capacity of the capacity-optimized cloud storage.

    0GB
    ArchiveStorage

    integer

    The billable storage capacity of the Archive Storage. Unit: GB.

    0GB
    ExpiredMilliseconds

    integer

    The timestamp that indicates when the instance expires. The timestamp is the number of milliseconds that have elapsed since 1970-01-01 00:00:00.

    1629993600000
    EngineType

    integer

    The types of the supported engines. The value of this parameter is the sum of the values of all supported engine types.

    • 1: search engine

    • 2: LindormTSDB

    • 4: LindormTable

    • 8: file engine

    Note

    For example, if the value of EngineType is 15, it indicates that the instance supports the search engine, LindormTSDB, LindormTable, and the file engine because 15 = 8 + 4 + 2 + 1. If the value of EngineType is 6, it indicates that the instance supports LindormTSDB and LindormTable because 6 = 4 + 2.

    15
    ExpireTime

    string

    The expiration time of the instance. The time is in the yyyy-MM-dd HH:mm:ss format.

    Note

    This parameter is returned only when the billing method of the instance is subscription.

    2021-08-27 00:00:00
    AutoRenew

    boolean

    Indicates whether auto-renewal is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    Note

    This parameter is returned only when the billing method of the instance is subscription.

    false
    DeletionProtection

    string

    Indicates whether release protection is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    InstanceStorage

    string

    The storage capacity of the instance.

    480
    AliUid

    integer

    The 16-digit UID of the Alibaba Cloud account.

    164901546557****
    InstanceId

    string

    The instance ID.

    ld-bp1o3y0yme2i2****
    RegionId

    string

    The region ID.

    cn-hangzhou
    CreateMilliseconds

    integer

    The timestamp that indicates when the instance was created. The timestamp is the number of milliseconds that have elapsed since 1970-01-01 00:00:00.

    1627290664000
    InstanceAlias

    string

    The alias of the instance.

    test0726
    DiskThreshold

    string

    The disk space threshold.

    80%
    ZoneId

    string

    The zone ID.

    cn-hangzhou-h
    InstanceStatus

    string

    The status of the instance. Valid values:

    • CREATING: The instance is being created.

    • ACTIVATION: The instance is running.

    • COLD_EXPANDING: The capacity-optimized cloud storage is being scaled out.

    • MINOR_VERSION_TRANSING: The minor version is being upgraded.

    • RESIZING: The nodes are being scaled out.

    • SHRINKING: The nodes are being scaled in.

    • CLASS_CHANGING: The instance specifications are being upgraded or downgraded.

    • SSL_SWITCHING: The SSL certificate is being changed.

    • CDC_OPENING: The change tracking feature is being enabled.

    • TRANSFER: Data is being migrated.

    • DATABASE_TRANSFER: Data is being migrated to the database.

    • GUARD_CREATING: A disaster recovery instance is being created.

    • BACKUP_RECOVERING: Data is being restored from a backup.

    • DATABASE_IMPORTING: Data is being imported.

    • NET_MODIFYING: The network is being modified.

    • NET_SWITCHING: The network type is being switched between internal and public.

    • NET_CREATING: A network connection is being created.

    • NET_DELETING: A network connection is being deleted.

    • DELETING: The instance is being deleted.

    • RESTARTING: The instance is being restarted.

    • LOCKED: The instance has expired and is locked.

    ACTIVATION
    EngineList

    array<object>

    The list of engine information.

    object

    The list of engine information.

    Version

    string

    The version of the engine.

    2.2.3
    CpuCount

    string

    The number of vCPUs for the engine node.

    4
    CoreCount

    string

    The number of engine nodes.

    2
    Engine

    string

    The type of the engine. Valid values:

    • lindorm: LindormTable.

    • tsdb: LindormTSDB.

    • solr: search engine.

    • store: file engine.

    • bds: LTS engine.

    • compute: compute engine.

    lindorm
    Specification

    string

    The specifications of the engine node.

    lindorm.g.2xlarge
    MemorySize

    string

    The memory size of the engine node.

    8GB
    IsLastVersion

    boolean

    Indicates whether the engine is of the latest version. Valid values:

    • true: The engine is of the latest version.

    • false: The engine is not of the latest version.

    false
    LatestVersion

    string

    The latest version of the engine.

    2.2.19.2
    PrimaryCoreCount

    string

    StandbyCoreCount

    string

    ArbiterCoreCount

    string

    EnableCompute

    boolean

    Indicates whether the compute engine is enabled for the instance. Valid values:

    • true: enabled.

    • false: disabled.

    true
    EnableSSL

    boolean

    Indicates whether SSL encryption is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    EnableMLCtrl

    boolean

    Indicates whether the AI control node is enabled.

    • True: enabled.

    • False: disabled.

    False
    EnableCdc

    boolean

    Indicates whether the change tracking feature is enabled for the instance. Valid values:

    • true: enabled.

    • false: disabled.

    false
    EnableStream

    boolean

    Indicates whether the stream engine is enabled for the instance. Valid values:

    • true: The stream engine is enabled.

    • false: The stream engine is disabled.

    true
    EnableLTS

    boolean

    Indicates whether the LTS engine is enabled for the instance. Valid values:

    • true: The LTS engine is enabled.

    • false: The LTS engine is disabled.

    true
    EnableShs

    boolean

    Indicates whether the History Server of the compute engine is enabled.

    true
    EnableBlob

    boolean

    Indicates whether LBlob is enabled for the instance. Valid values:

    true: LBlob is enabled. false: LBlob is disabled.

    true
    MaintainStartTime

    string

    The start time of the maintenance window.

    00:00Z
    MaintainEndTime

    string

    The end time of the maintenance window.

    20:00Z
    ResourceGroupId

    string

    The resource group ID.

    rg-aek2wvd6oia****
    PrimaryZoneId

    string

    The ID of the primary zone for the multi-zone instance.

    cn-shanghai-e
    StandbyZoneId

    string

    The ID of the secondary zone for the multi-zone instance.

    cn-shanghai-f
    ArbiterZoneId

    string

    The ID of the arbiter zone for the multi-zone instance.

    cn-shanghai-g
    PrimaryVSwitchId

    string

    The ID of the vSwitch in the primary zone for the multi-zone instance. The vSwitch must be in the zone that is specified by PrimaryZoneId.

    vsw-uf6fdqa7c0pipnqzq****
    StandbyVSwitchId

    string

    The ID of the vSwitch in the secondary zone for the multi-zone instance. The vSwitch must be in the zone that is specified by StandbyZoneId.

    vsw-2zec0kcn08cgdtr6****
    ArbiterVSwitchId

    string

    The ID of the vSwitch in the arbiter zone for the multi-zone instance. The vSwitch must be in the zone that is specified by ArbiterZoneId.

    vsw-uf6664pqjawb87k36****
    MultiZoneCombination

    string

    The combination of zones for the multi-zone instance. For more information about the supported zone combinations, go to the buy page of Lindorm.

    • ap-southeast-5abc-aliyun: Indonesia (Jakarta) Zone A+B+C.

    • cn-hangzhou-ehi-aliyun: China (Hangzhou) Zone E+H+I.

    • cn-beijing-acd-aliyun: China (Beijing) Zone A+C+D.

    • ap-southeast-1-abc-aliyun: Singapore Zone A+B+C.

    • cn-zhangjiakou-abc-aliyun: China (Zhangjiakou) Zone A+B+C.

    • cn-shanghai-efg-aliyun: China (Shanghai) Zone E+F+G.

    • cn-shanghai-abd-aliyun: China (Shanghai) Zone A+B+D.

    • cn-hangzhou-bef-aliyun: China (Hangzhou) Zone B+E+F.

    • cn-hangzhou-bce-aliyun: China (Hangzhou) Zone B+C+E.

    • cn-beijing-fgh-aliyun: China (Beijing) Zone F+G+H.

    • cn-shenzhen-abc-aliyun: China (Shenzhen) Zone A+B+C.

    cn-shanghai-efg-aliyun
    CoreDiskCategory

    string

    The disk type of the core nodes for the multi-zone instance. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: performance cloud storage.

    • cloud_essd: ESSD cloud storage.

    • cloud_essd_pl0: ESSD PL0 cloud storage.

    cloud_efficiency
    CoreSpec

    string

    The specifications of the core nodes for the multi-zone instance.

    lindorm.g.xlarge
    CoreNum

    integer

    The number of core nodes for the multi-zone instance.

    4
    CoreSingleStorage

    integer

    The disk capacity of a single core node for the multi-zone instance.

    400
    LogDiskCategory

    string

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

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: performance cloud storage.

    cloud_ssd
    LogSpec

    string

    The specifications of the log nodes for the multi-zone instance.

    lindorm.sn1.large
    LogNum

    integer

    The number of log nodes for the multi-zone instance.

    4
    LogSingleStorage

    integer

    The disk capacity of a single log node for the multi-zone instance.

    400GB
    ArchVersion

    string

    The deployment architecture. Valid values:

    • 1.0: single-zone.

    • 2.0: multi-zone.

    1.0
    EnableLsqlVersionV3

    boolean

    Indicates whether LindormTable supports LindormSQL V3. LindormSQL V3 is compatible with the MySQL protocol. This feature is enabled by default for instances that are purchased after October 24, 2023. For existing instances, contact the on-duty engineer for evaluation before you enable this feature.

    • True: supported

    • False: not supported

    True
    EnableLProxy

    boolean

    Indicates whether LindormTable supports the Thrift and CQL protocols. If LindormTable does not support these protocols, you can call the SwitchLProxyService operation to enable or disable the protocols.

    True: supported

    False: not supported

    False
    Description

    Examples

    Success response

    JSON format

    {
  "VpcId": "vpc-bp1n3i15v90el48nx****",
  "VswitchId": "vsw-bp1vbjzmod9q3l9eo****",
  "CreateTime": "2021-07-26 17:10:26",
  "PayType": "POSTPAY",
  "NetworkType": "vpc",
  "ServiceType": "lindorm",
  "EnableKms": false,
  "EnableStoreTDE": false,
  "DiskUsage": "0.0%",
  "DiskCategory": "cloud_efficiency",
  "RequestId": "633F1BE4-C8DA-5744-8FDF-A3075C3FE37F",
  "ColdStorage": 0,
  "ArchiveStorage": 0,
  "ExpiredMilliseconds": 1629993600000,
  "EngineType": 15,
  "ExpireTime": "2021-08-27 00:00:00",
  "AutoRenew": false,
  "DeletionProtection": "false",
  "InstanceStorage": "480",
  "AliUid": 0,
  "InstanceId": "ld-bp1o3y0yme2i2****",
  "RegionId": "cn-hangzhou",
  "CreateMilliseconds": 1627290664000,
  "InstanceAlias": "test0726",
  "DiskThreshold": "80%",
  "ZoneId": "cn-hangzhou-h",
  "InstanceStatus": "ACTIVATION",
  "EngineList": [
    {
      "Version": "2.2.3",
      "CpuCount": "4",
      "CoreCount": "2",
      "Engine": "lindorm",
      "Specification": "lindorm.g.2xlarge",
      "MemorySize": "8GB",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2",
      "PrimaryCoreCount": "",
      "StandbyCoreCount": "",
      "ArbiterCoreCount": ""
    }
  ],
  "EnableCompute": true,
  "EnableSSL": false,
  "EnableMLCtrl": true,
  "EnableCdc": false,
  "EnableStream": true,
  "EnableLTS": true,
  "EnableShs": true,
  "EnableBlob": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "ResourceGroupId": "rg-aek2wvd6oia****",
  "PrimaryZoneId": "cn-shanghai-e",
  "StandbyZoneId": "cn-shanghai-f",
  "ArbiterZoneId": "cn-shanghai-g",
  "PrimaryVSwitchId": "vsw-uf6fdqa7c0pipnqzq****",
  "StandbyVSwitchId": "vsw-2zec0kcn08cgdtr6****",
  "ArbiterVSwitchId": "vsw-uf6664pqjawb87k36****",
  "MultiZoneCombination": "cn-shanghai-efg-aliyun",
  "CoreDiskCategory": "cloud_efficiency",
  "CoreSpec": "lindorm.g.xlarge",
  "CoreNum": 4,
  "CoreSingleStorage": 400,
  "LogDiskCategory": "cloud_ssd",
  "LogSpec": "lindorm.sn1.large",
  "LogNum": 4,
  "LogSingleStorage": 0,
  "ArchVersion": "1.0",
  "EnableLsqlVersionV3": true,
  "EnableLProxy": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Instance.IsDeleted The instance is deleted.
    400 Instance.IsNotValid The instance is invalid. The specified instance 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.