GetLindormInstance API Parameters & Response Fields - Lindorm - Alibaba Cloud - Lindorm

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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call GetLindormInstanceList to retrieve the instance ID.	ld-bp1o3y0yme2i2****

Response elements

Element	Type	Description	Example
	object
VpcId	string	The ID of the VPC to which the instance belongs.	vpc-bp1n3i15v90el48nx****
VswitchId	string	The vSwitch ID.	vsw-bp1vbjzmod9q3l9eo****
CreateTime	string	The time when the instance was created. Format: yyyy-MM-dd HH:mm:ss.	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 instance.	lindorm
EnableKms	boolean	Indicates whether Key Management Service (KMS) is enabled. Valid values: true: enabled. false: disabled.	false
EnableStoreTDE	boolean	Indicates whether the Cloud Hardware Security Module (CloudHSM) 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 request ID.	633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
ColdStorage	integer	The storage capacity of storage-optimized cloud storage.	0GB
ArchiveStorage	integer	The billed storage capacity for archive storage, in GB.	0GB
ExpiredMilliseconds	integer	The number of milliseconds between the instance expiration time and 1970-01-01 00:00:00.	1629993600000
EngineType	integer	The engine types supported by the instance. The returned value is the sum of the following engine type values: 1: search search engine 2: LindormTSDB 4: LindormTable 8: file engine Note For example, an EngineType value of 15 means 15=8+4+2+1, indicating that the instance supports the search search engine, LindormTSDB, LindormTable, and the file engine. An EngineType value of 6 means 6=4+2, indicating that the instance supports LindormTSDB and LindormTable.	15
ExpireTime	string	The expiration time of the instance. Format: yyyy-MM-dd HH:mm:ss. Note This parameter is returned only for subscription instances.	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 for subscription instances.	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-digit AliUid of the Alibaba Cloud account.	164901546557****
InstanceId	string	The instance ID.	ld-bp1o3y0yme2i2****
RegionId	string	The region ID.	cn-hangzhou
CreateMilliseconds	integer	The number of milliseconds between the instance creation time and 1970-01-01 00:00:00.	1627290664000
InstanceAlias	string	The instance name.	test0726
DiskThreshold	string	The disk space threshold.	80%
ZoneId	string	The zone ID.	cn-hangzhou-h
InstanceStatus	string	The instance status. Valid values: CREATING: creating. ACTIVATION: running. COLD_EXPANDING: storage expansion of capacity cloud storage in progress. MINOR_VERSION_TRANSING: minor version upgrade in progress. RESIZING: scaling out nodes. SHRINKING: scaling in nodes. CLASS_CHANGING: upgrading or downgrading specifications. SSL_SWITCHING: changing SSL settings. CDC_OPENING: enabling the data subscription feature. TRANSFER: data migration in progress. DATABASE_TRANSFER: data migration to a database in progress. GUARD_CREATING: creating a disaster recovery instance. BACKUP_RECOVERING: restoring from a backup. DATABASE_IMPORTING: data import in progress. NET_MODIFYING: changing the network. NET_SWITCHING: switching between internal network and public network. NET_CREATING: creating a network connection. NET_DELETING: deleting a network connection. DELETING: deleting. RESTARTING: restarting. LOCKED: locked because the instance has expired.	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 CPUs on each engine node.	4
CoreCount	string	The number of engine nodes.	2
Engine	string	The engine type. Valid values: lindorm: LindormTable. tsdb: LindormTSDB. solr: search index. store: file engine. bds: LTS engine. compute: compute engine.	lindorm
Specification	string	The node specifications of each engine node.	lindorm.g.2xlarge
MemorySize	string	The memory size of each engine node.	8GB
IsLastVersion	boolean	Indicates whether the engine is running the latest version. Valid values: true: latest version. false: not the latest version.	false
LatestVersion	string	The latest version available for 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: not enabled.	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: not enabled.	False
EnableCdc	boolean	Indicates whether the data subscription feature is enabled for the instance. Valid values: true: enabled. false: not enabled.	false
EnableStream	boolean	Indicates whether the streaming engine is enabled for the instance. Valid values: true: enabled. false: not enabled.	true
EnableLTS	boolean	Indicates whether the LTS engine is enabled for the instance. Valid values: true: enabled. false: not enabled.	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: not enabled.	true
MaintainStartTime	string	The start time of the maintenance window. Format: HH:mmZ (UTC).	00:00Z
MaintainEndTime	string	The end time of the maintenance window. Format: HH:mmZ (UTC).	20:00Z
ResourceGroupId	string	The resource group ID.	rg-aek2wvd6oia****
PrimaryZoneId	string	The zone ID of the primary zone for a multi-zone instance.	cn-shanghai-e
StandbyZoneId	string	The zone ID of the secondary zone for a multi-zone instance.	cn-shanghai-f
ArbiterZoneId	string	The zone ID of the arbiter zone for a multi-zone instance.	cn-shanghai-g
PrimaryVSwitchId	string	The 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	The 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	The 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	The multi-zone combination. For supported zone combinations, see the purchase page. Valid values: 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.	cn-shanghai-efg-aliyun
CoreDiskCategory	string	The disk type of core nodes 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 node specifications of core nodes 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 each core node for a multi-zone instance.	400
LogDiskCategory	string	The disk type of log nodes for a multi-zone instance. Valid values: cloud_efficiency: standard cloud storage. cloud_ssd: performance cloud storage.	cloud_ssd
LogSpec	string	The node specifications of log nodes 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 each log node for a multi-zone instance.	400GB
BackupInstance	string	The backup instance.	ld-xxxx
EnableLsqlVersionV3	boolean	Indicates whether LindormSQL V3, which is compatible with the MySQL protocol, is supported by LindormTable. Instances purchased after October 24, 2023 support this feature by default. For existing instances, contact the on-call team 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 enable or disable this feature by calling the SwitchLProxyService operation. 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 single-zone risk alert information.
NeedAlert	boolean	Indicates whether a single-zone risk alert is required.	true
DispositionType	string	The disposition type for the single-zone risk.
PlannedCompletionDate	string	The planned completion date for risk disposition. Format: yyyy-MM-dd.	2026-09-30
ConfirmDate	string	The confirmation date for risk disposition. Format: yyyy-MM-dd.	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": "",
    "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.