All Products
Search

This Product

    Lindorm:GetLindormInstance

    Document Center

    Lindorm:GetLindormInstance

    Last Updated:Feb 04, 2026

    Retrieve detailed information about a Lindorm instance, such as the instance type, billing method, and associated virtual private cloud (VPC).

    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:GetLindormInstance

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    Instance ID. Call the GetLindormInstanceList operation to get this value.

    ld-bp1o3y0yme2i2****

    Response elements

    Element

    Type

    Description

    Example

    object

    VpcId

    string

    ID of the VPC that hosts the instance.

    vpc-bp1n3i15v90el48nx****
    VswitchId

    string

    ID of the vSwitch.

    vsw-bp1vbjzmod9q3l9eo****
    CreateTime

    string

    Time when the instance was created, in yyyy-MM-dd HH:mm:ss format.

    2021-07-26 17:10:26
    PayType

    string

    Billing method for the instance. Valid values:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    POSTPAY
    NetworkType

    string

    Network type of the instance.

    vpc
    ServiceType

    string

    Instance type. Valid values:

    • lindorm: single-zone Lindorm instance.

    • lindorm_multizone: multi-zone Lindorm instance.

    • serverless_lindorm: serverless Lindorm instance.

    • lindorm_standalone: standalone Lindorm instance.

    • lts: Lindorm Tunnel Service (LTS) instance.

    lindorm
    EnableKms

    boolean

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

    • true: enabled.

    • false: disabled.

    false
    EnableStoreTDE

    boolean

    Whether storage encryption is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    DiskUsage

    string

    Disk usage percentage.

    0.0%
    DiskCategory

    string

    Storage class. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: compute-optimized cloud storage.

    • cloud_essd: enhanced compute-optimized cloud storage.

    • cloud_essd_pl0: compute-optimized cloud storage pl0.

    • capacity_cloud_storage: storage-optimized cloud storage.

    • local_ssd_pro: local SSD.

    • local_hdd_pro: local HDD.

    cloud_efficiency
    RequestId

    string

    Request ID.

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

    integer

    Capacity of capacity cloud storage, in GB.

    0GB
    ArchiveStorage

    integer

    Billing size of Archive Storage, in GB.

    0GB
    ExpiredMilliseconds

    integer

    Number of milliseconds between the instance expiration time and 1970-01-01 00:00:00 UTC.

    1629993600000
    EngineType

    integer

    Type of engines supported by the instance. This value is the sum of engine type values.

    • 1: search engine.

    • 2: time-series engine.

    • 4: wide-column engine.

    • 8: file engine.

    Note

    For example, if EngineType is 15, then 15 = 8 + 4 + 2 + 1. This means the instance supports the search engine, time-series engine, wide-column engine, and file engine. If EngineType is 6, then 6 = 4 + 2. This means the instance supports the time-series engine and wide-column engine.

    15
    ExpireTime

    string

    Expiration time of the instance, in yyyy-MM-dd HH:mm:ss format.

    Note

    This parameter is returned only for subscription instances.

    2021-08-27 00:00:00
    AutoRenew

    boolean

    Whether auto-renewal is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    Note

    This parameter is returned only for subscription instances.

    false
    DeletionProtection

    string

    Whether deletion protection is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    InstanceStorage

    string

    Storage capacity of the instance.

    480
    AliUid

    integer

    16-digit AliUid of the Alibaba Cloud account (root account).

    164901546557****
    InstanceId

    string

    Instance ID.

    ld-bp1o3y0yme2i2****
    RegionId

    string

    Region ID.

    cn-hangzhou
    CreateMilliseconds

    integer

    Number of milliseconds between the instance creation time and 1970-01-01 00:00:00 UTC.

    1627290664000
    InstanceAlias

    string

    Instance name.

    test0726
    DiskThreshold

    string

    Disk usage threshold.

    80%
    ZoneId

    string

    Zone ID.

    cn-hangzhou-h
    InstanceStatus

    string

    Status of the instance. Valid values:

    • CREATING: creating.

    • ACTIVATION: running.

    • COLD_EXPANDING: expanding capacity cloud storage.

    • MINOR_VERSION_TRANSING: upgrading minor version.

    • RESIZING: scaling up nodes.

    • SHRINKING: scaling down nodes.

    • CLASS_CHANGING: changing specifications (upgrading or downgrading).

    • SSL_SWITCHING: changing SSL settings.

    • CDC_OPENING: enabling change tracking.

    • TRANSFER: migrating data.

    • DATABASE_TRANSFER: migrating data to a database.

    • GUARD_CREATING: creating disaster recovery instance.

    • BACKUP_RECOVERING: restoring from backup.

    • DATABASE_IMPORTING: importing data.

    • NET_MODIFYING: modifying network settings.

    • NET_SWITCHING: switching between internal and external networks.

    • NET_CREATING: creating network connection.

    • NET_DELETING: deleting network connection.

    • DELETING: deleting.

    • RESTARTING: restarting.

    • LOCKED: locked due to expiration.

    ACTIVATION
    EngineList

    array<object>

    List of engine information.

    object

    Engine information.

    Version

    string

    Version number of the engine type.

    2.2.3
    CpuCount

    string

    Number of CPUs per engine node.

    4
    CoreCount

    string

    Number of engine nodes.

    2
    Engine

    string

    Type of engine. Valid values:

    • lindorm: wide-column engine.

    • tsdb: time-series engine.

    • solr: search engine.

    • store: file engine.

    • bds: LTS engine.

    • compute: compute engine.

    lindorm
    Specification

    string

    Node specification for the engine.

    lindorm.g.2xlarge
    MemorySize

    string

    Memory size per engine node.

    8GB
    IsLastVersion

    boolean

    Whether the engine type is at the latest version. Valid values:

    • true: latest version.

    • false: not the latest version.

    false
    LatestVersion

    string

    Latest version number for the engine type.

    2.2.19.2
    PrimaryCoreCount

    string

    StandbyCoreCount

    string

    ArbiterCoreCount

    string

    EnableCompute

    boolean

    Whether the compute engine is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    true
    EnableSSL

    boolean

    Whether SSL link encryption is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    EnableMLCtrl

    boolean

    Whether AI control node is enabled.

    • True: enabled.

    • False: disabled.

    False
    EnableCdc

    boolean

    Whether change tracking is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    EnableStream

    boolean

    Whether the stream engine is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    true
    EnableLTS

    boolean

    Whether the LTS engine is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    true
    EnableShs

    boolean

    Whether the compute engine History Server is enabled.

    true
    EnableBlob

    boolean

    true: enabled.

    false: disabled.

    true
    MaintainStartTime

    string

    Maintenance window start time.

    00:00Z
    MaintainEndTime

    string

    Maintenance window end time.

    20:00Z
    ResourceGroupId

    string

    Resource group ID.

    rg-aek2wvd6oia****
    PrimaryZoneId

    string

    Zone ID of the primary zone for a multi-zone instance.

    cn-shanghai-e
    StandbyZoneId

    string

    Zone ID of the secondary zone for a multi-zone instance.

    cn-shanghai-f
    ArbiterZoneId

    string

    Zone ID of the arbiter zone for a multi-zone instance.

    cn-shanghai-g
    PrimaryVSwitchId

    string

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

    vsw-uf6fdqa7c0pipnqzq****
    StandbyVSwitchId

    string

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

    vsw-2zec0kcn08cgdtr6****
    ArbiterVSwitchId

    string

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

    vsw-uf6664pqjawb87k36****
    MultiZoneCombination

    string

    Multi-zone combination. For supported combinations, see the product page.

    • ap-southeast-5abc-aliyun: Jakarta A+B+C.

    • cn-hangzhou-ehi-aliyun: Hangzhou E+H+I.

    • cn-beijing-acd-aliyun: Beijing A+C+D.

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

    • cn-zhangjiakou-abc-aliyun: Zhangjiakou A+B+C.

    • cn-shanghai-efg-aliyun: Shanghai E+F+G.

    • cn-shanghai-abd-aliyun: Shanghai A+B+D.

    • cn-hangzhou-bef-aliyun: Hangzhou B+E+F.

    • cn-hangzhou-bce-aliyun: Hangzhou B+C+E.

    • cn-beijing-fgh-aliyun: Beijing F+G+H.

    • cn-shenzhen-abc-aliyun: Shenzhen A+B+C.

    cn-shanghai-efg-aliyun
    CoreDiskCategory

    string

    Disk type for core nodes in a multi-zone instance. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: compute-optimized cloud storage.

    • cloud_essd: enhanced compute-optimized cloud storage.

    • cloud_essd_pl0: compute-optimized cloud storage pl0.

    cloud_efficiency
    CoreSpec

    string

    Node specification for core nodes in a multi-zone instance.

    lindorm.g.xlarge
    CoreNum

    integer

    Number of core nodes in a multi-zone instance.

    4
    CoreSingleStorage

    integer

    Disk capacity per core node in a multi-zone instance.

    400
    LogDiskCategory

    string

    Disk type for log nodes in a multi-zone instance. Valid values:

    • cloud_efficiency: standard cloud storage.

    • cloud_ssd: compute-optimized cloud storage.

    cloud_ssd
    LogSpec

    string

    Node specification for log nodes in a multi-zone instance.

    lindorm.sn1.large
    LogNum

    integer

    Number of log nodes in a multi-zone instance.

    4
    LogSingleStorage

    integer

    Disk capacity per log node in a multi-zone instance.

    400GB
    BackupInstance

    string

    EnableLsqlVersionV3

    boolean

    Whether the wide-column engine supports LindormSQL-V3, which is compatible with MySQL protocol. Instances purchased after October 24, 2023 support this feature by default. For existing instances, contact Alibaba Cloud support to evaluate before enabling.

    • True: supported.

    • False: not supported.

    True
    EnableLProxy

    boolean

    Whether the wide-column engine supports Thrift and CQL protocols. If not supported, use the SwitchLProxyService operation to enable or disable it.

    True: supported.

    False: not supported.

    False
    ArchVersion

    string

    Deployment architecture. Valid values:

    • 1.0: single-zone.

    • 2.0: multi-zone.

    1.0
    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,
  "BackupInstance": "",
  "EnableLsqlVersionV3": true,
  "EnableLProxy": true,
  "ArchVersion": "1.0"
}

    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.