DocsICP FilingConsole
Documentation

GetLindormInstance

Updated at:
Copy as MD
Product
My Favorites

Retrieves the details of a Lindorm instance, including 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

The ID of the instance. You can 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 ID of the vSwitch.

vsw-bp1vbjzmod9q3l9eo****
CreateTime

string

The time when the instance was created. The time is displayed 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 instance type. Valid values:

  • lindorm: Lindorm single-zone instance.

  • lindorm_multizone: Lindorm multi-zone instance.

  • serverless_lindorm: Lindorm Serverless instance.

  • lindorm_standalone: Lindorm single-node instance.

  • lts: Lindorm Tunnel Service.

lindorm
EnableKms

boolean

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

  • true: enabled.

  • false: disabled.

false
EnableStoreTDE

boolean

Indicates whether storage encryption is enabled. Valid values:

  • true: enabled.

  • false: disabled.

false
DiskUsage

string

The disk space usage.

0.0%
DiskCategory

string

The storage type. Valid values:

  • cloud_efficiency: standard cloud storage.

  • cloud_ssd: performance cloud storage.

  • cloud_essd: enhanced performance cloud storage.

  • cloud_essd_pl0: performance cloud storage PL0.

  • capacity_cloud_storage: capacity cloud storage.

  • local_ssd_pro: local SSD.

  • local_hdd_pro: local HDD.

cloud_efficiency
RequestId

string

The ID of the request.

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

integer

Storage capacity of storage capacity cloud storage.

0
ArchiveStorage

integer

The billable storage capacity of the archive storage type. Unit: GB.

0
ExpiredMilliseconds

integer

The time when the instance expires, represented as the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1629993600000
EngineType

integer

The supported engine types. The return value is the sum of the values of the following engine types:

  • 1: search engine

  • 2: LindormTSDB

  • 4: LindormTable

  • 8: file engine

Note

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

15
ExpireTime

string

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

Note

This parameter is returned only when the billing method 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 deletion protection is enabled. Valid values:

  • true: enabled.

  • false: disabled.

false
InstanceStorage

string

The storage capacity of the instance.

480
AliUid

integer

The 16-character AliUid of the Alibaba Cloud account.

164901546557****
InstanceId

string

The instance ID.

ld-bp1o3y0yme2i2****
RegionId

string

The region ID.

cn-hangzhou
CreateMilliseconds

integer

The creation time of the instance, represented as the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1627290664000
InstanceAlias

string

The name of the instance.

test0726
DiskThreshold

string

The disk space threshold.

80%
ZoneId

string

The zone ID.

cn-hangzhou-h
InstanceStatus

string

The instance status. Valid values:

  • CREATING: The instance is being created.

  • ACTIVATION: The instance is running.

  • COLD_EXPANDING: Capacity cloud storage expansion in progress.

  • MINOR_VERSION_TRANSING: The minor version is being upgraded.

  • RESIZING: The nodes are being scaled up.

  • SHRINKING: The nodes are being scaled down.

  • CLASS_CHANGING: Instance specification upgrade or downgrade in progress.

  • SSL_SWITCHING: The SSL certificate is being changed.

  • CDC_OPENING: The data subscription feature is being enabled.

  • TRANSFER: Data migration in progress.

  • DATABASE_TRANSFER: Data is being migrated to the database.

  • GUARD_CREATING: A disaster recovery instance is being created.

  • BACKUP_RECOVERING: The backup is being restored.

  • DATABASE_IMPORTING: Data import in progress.

  • NET_MODIFYING: The network is being modified.

  • NET_SWITCHING: The network is being switched between the internal network and the Internet.

  • 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 number of the engine.

2.2.3
CpuCount

string

The number of CPUs for the engine node.

4
CoreCount

string

The number of engine nodes.

2
Engine

string

The engine type. Valid values:

  • lindorm: LindormTable.

  • tsdb: LindormTSDB.

  • solr: search engine.

  • store: file engine.

  • bds: Lindorm Tunnel Service engine.

  • compute: compute engine.

lindorm
Specification

string

The engine node specifications.

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: latest version.

  • false: not the latest version.

false
LatestVersion

string

The latest version number of the engine.

2.2.19.2
PrimaryCoreCount

string

The number of nodes in the primary zone.

2
StandbyCoreCount

string

The number of nodes in the secondary zone.

2
ArbiterCoreCount

string

The number of nodes in the arbiter zone.

2
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. Valid values:

  • True: enabled.

  • False: disabled.

False
EnableCdc

boolean

Indicates whether the data subscription feature is enabled for the instance. Valid values:

  • true: enabled.

  • false: disabled.

false
EnableStream

boolean

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

  • true: enabled.

  • false: disabled.

true
EnableLTS

boolean

Indicates whether Lindorm Tunnel Service is enabled for the instance. Valid values:

  • true: enabled.

  • false: disabled.

true
EnableShs

boolean

Indicates whether History Server for the compute engine is enabled.

true
EnableBlob

boolean

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

  • true: enabled.

  • false: disabled.

true
MaintainStartTime

string

The start time of the maintenance window. The time is displayed in the HH:mmZ format. UTC time is used.

00:00Z
MaintainEndTime

string

The end time of the maintenance window. The time is displayed in the HH:mmZ format. UTC time is used.

20:00Z
ResourceGroupId

string

The ID of the resource group.

rg-aek2wvd6oia****
PrimaryZoneId

string

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

cn-shanghai-e
StandbyZoneId

string

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

cn-shanghai-f
ArbiterZoneId

string

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

cn-shanghai-g
PrimaryVSwitchId

string

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

vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchId

string

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

vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchId

string

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

vsw-uf6664pqjawb87k36****
MultiZoneCombination

string

The multi-zone combination. You can go to the buy page to view the supported zone combinations. Valid values:

  • ap-southeast-5abc-aliyun: Indonesia (Jakarta) Zones A, B, and C.

  • cn-hangzhou-ehi-aliyun: China (Hangzhou) Zones E, H, and I.

  • cn-beijing-acd-aliyun: China (Beijing) Zones A, C, and D.

  • ap-southeast-1-abc-aliyun: Singapore Zones A, B, and C.

  • cn-zhangjiakou-abc-aliyun: China (Zhangjiakou) Zones A, B, and C.

  • cn-shanghai-efg-aliyun: China (Shanghai) Zones E, F, and G.

  • cn-shanghai-abd-aliyun: China (Shanghai) Zones A, B, and D.

  • cn-hangzhou-bef-aliyun: China (Hangzhou) Zones B, E, and F.

  • cn-hangzhou-bce-aliyun: China (Hangzhou) Zones B, C, and E.

  • cn-beijing-fgh-aliyun: China (Beijing) Zones F, G, and H.

  • cn-shenzhen-abc-aliyun: China (Shenzhen) Zones A, B, and C.

cn-shanghai-efg-aliyun
CoreDiskCategory

string

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

  • cloud_efficiency: standard cloud storage.

  • cloud_ssd: performance cloud storage.

  • cloud_essd: enhanced performance cloud storage.

  • cloud_essd_pl0: performance cloud storage PL0.

cloud_efficiency
CoreSpec

string

The core node specifications for a multi-zone instance.

lindorm.g.xlarge
CoreNum

integer

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

4
CoreSingleStorage

integer

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

400
LogDiskCategory

string

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

  • cloud_efficiency: standard cloud storage.

  • cloud_ssd: performance cloud storage.

cloud_ssd
LogSpec

string

The log node specifications for a multi-zone instance.

lindorm.sn1.large
LogNum

integer

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

4
LogSingleStorage

integer

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

400GB
BackupInstance

string

The backup instance.

ld-xxxx
EnableLsqlVersionV3

boolean

Indicates whether LindormTable supports LindormSQL-V3, which is compatible with the MySQL protocol. Instances purchased after October 24, 2023 support this feature by default. For existing instances, contact technical support for evaluation before enabling this feature. Valid values:

  • True: supported.

  • False: not supported.

True
EnableLProxy

boolean

Indicates whether LindormTable supports the Thrift and CQL protocols. If not supported, you can call the SwitchLProxyService operation to enable or disable the support. Valid values:

  • True: supported.

  • False: not supported.

False
ArchVersion

string

The deployment architecture. Valid values:

  • 1.0: single-zone.

  • 2.0: multi-zone.

1.0
SingleZoneRiskAlert

object

The risk alert information for the single-zone deployment.

NeedAlert

boolean

Indicates whether a risk alert for the single-zone deployment is required.

true
DispositionType

string

The risk handling type for the single-zone deployment.

NO_SET
PlannedCompletionDate

string

The planned completion date for risk handling. The date is displayed in the yyyy-MM-dd format.

2026-09-30
ConfirmDate

string

The confirmation date for risk handling. The date is displayed in the yyyy-MM-dd format.

2026-09-24

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": "2",
      "StandbyCoreCount": "2",
      "ArbiterCoreCount": "2"
    }
  ],
  "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": "ld-xxxx",
  "EnableLsqlVersionV3": true,
  "EnableLProxy": true,
  "ArchVersion": "1.0",
  "SingleZoneRiskAlert": {
    "NeedAlert": true,
    "DispositionType": "NO_SET",
    "PlannedCompletionDate": "2026-09-30",
    "ConfirmDate": "2026-09-24"
  }
}

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.