All Products
Search
Document Center

Lindorm:GetLindormInstance

Last Updated:Mar 25, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Obtains the detailed information about a Lindorm instance, including the instance type, billing method, and VPC.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
lindorm:GetLindormInstanceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The disk type of the log nodes. This parameter is returned only for multi-zone instances. Valid values:

  • cloud_efficiency: The nodes use the Standard type of storage.
  • cloud_ssd: The nodes use the Performance type of storage.
ld-bp1o3y0yme2i2****

Response parameters

ParameterTypeDescriptionExample
object
VpcIdstring

The type of the log nodes. This parameter is returned only for multi-zone instances.

vpc-bp1n3i15v90el48nx****
VswitchIdstring

The number of the log nodes. This parameter is returned only for multi-zone instances.

vsw-bp1vbjzmod9q3l9eo****
CreateTimestring

The storage capacity of the disk of a single log node. This parameter is returned only for multi-zone instances.

2021-07-26 17:10:26
PayTypestring

The billing method of the instance. Valid values:

PREPAY: subscription. POSTPAY: pay-as-you-go.

POSTPAY
NetworkTypestring

Instance's network type.

vpc
ServiceTypestring

Instance type, valid values:

  • lindorm: represents a Lindorm single-zone instance.
  • lindorm_multizone: represents a Lindorm multi-zone instance.
  • serverless_lindorm: represents a Lindorm Serverless instance.
  • lindorm_standalone: represents a Lindorm standalone instance.
  • lts: represents the Lindorm Data Channel Service type.
lindorm
EnableKmsboolean

Indicates whether the Key Management Service (KMS) is enabled, returning:

  • true: Enabled.
  • false: Disabled.
false
EnableStoreTDEboolean

Indicates whether the Transparent Data Encryption (TDE) is enabled, returning:

  • true: Enabled.
  • false: Disabled.
false
DiskUsagestring

Disk space usage rate.

0.0%
DiskCategorystring

The storage type of the instance. Valid values:

  • cloud_efficiency: This instance uses the Standard type of storage.
  • cloud_ssd: This instance uses the Performance type of storage.
  • cloud_essd: This instance uses ESSDs for storage.
  • cloud_essd_pl0: This instance uses PL0 ESSDs for storage.
  • capacity_cloud_storage: This instance uses the Capacity type of storage.
  • local_ssd_pro: This instance uses local SSDs for storage.
  • local_hdd_pro: This instance uses local HDDs for storage.
cloud_efficiency
RequestIdstring

Request ID.

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

The Capacity storage size of the instance.

0GB
ArchiveStorageinteger

The Archive storage size of the instance.

0GB
ExpiredMillisecondslong

The millisecond value between the instance expiration time and 1970-01-01 00:00:00.

1629993600000
EngineTypeinteger

Supported engine types, the return value is obtained by performing addition operations on the values of the following engine types.

  • 1: Search Engine
  • 2: Time Series Engine
  • 4: Wide Table Engine
  • 8: File Engine
Note For example: If EngineType is 15, where 15 = 8 + 4 + 2 + 1, it indicates that the instance supports Search Engine, Time Series Engine, Wide Table Engine, and File Engine. If EngineType is 6, where 6 = 4 + 2, it signifies that the instance supports Time Series Engine and Wide Table Engine.
15
ExpireTimestring

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

Note This parameter is only returned when the payment type is pre-paid.
2021-08-27 00:00:00
AutoRenewboolean

Indicates whether auto-renewal is enabled, with the following returns:

  • true: Enabled.
  • false: Disabled.
Note This parameter is returned when the instance's payment type is prepaid.
false
DeletionProtectionstring

Indicates whether deletion protection is enabled, returning:

  • true: Enabled.
  • false: Disabled.
false
InstanceStoragestring

Instance's storage capacity.

480
AliUidlong

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

164901546557****
InstanceIdstring

Instance ID.

ld-bp1o3y0yme2i2****
RegionIdstring

Region ID.

cn-hangzhou
CreateMillisecondslong

The timestamp in milliseconds between the instance creation time and 1970-01-01 00:00:00.

1627290664000
InstanceAliasstring

Instance name.

test0726
DiskThresholdstring

The threshold for disk space.

80%
ZoneIdstring

Availability Zone ID.

cn-hangzhou-h
InstanceStatusstring

The status of the instance. Valid values:

  • CREATING: The instance is being created.
  • ACTIVATION: The instance is running.
  • COLD_EXPANDING: The Capacity storage of the instance is being scaled up.
  • MINOR_VERSION_TRANSING: The minor version of the instance is being updated.
  • RESIZING: The nodes in the instance are being scaled up.
  • SHRINKING: The nodes in the instance are being scaled down.
  • CLASS_CHANGING: The specification of the instance is being changed.
  • SSL_SWITCHING: SSL: The SSL configurations of the instance are being changed.
  • CDC_OPENING: Data subscription is being enabled for the instance.
  • TRANSFER: The data of the instance is being transferred.
  • DATABASE_TRANSFER: The data of the instance is being transferred to databases.
  • GUARD_CREATING: A disaster recovery instance is being created.
  • BACKUP_RECOVERING: The data of the instance is being restored from a backup.
  • DATABASE_IMPORTING: Data is being imported to the instance.
  • NET_MODIFYING: The network configurations of the instance are being changed.
  • NET_SWITCHING: The network of the instance is being switched between a virtual private cloud (VPC) and the Internet.
  • NET_CREATING: The connection to the instance is being created.
  • NET_DELETING: The connection to the instance is being deleted.
  • DELETING: The instance is being deleted.
  • RESTARTING: The instance is restarting.
  • LOCKED: The instance is locked because it expires.
ACTIVATION
EngineListarray<object>

The list of engines supported by the instance.

Engineobject

The list of engines supported by the instance.

Versionstring

The version of the engine.

2.2.3
CpuCountstring

The number of CPU cores on the engine node.

4
CoreCountstring

The number of engine nodes.

2
Enginestring

The engine type. Valid values:

  • lindorm: LindormTable.
  • tsdb: LindormTSDB.
  • solr: LindormSearch.
  • store: LindormDFS.
  • bds: Lindorm Tunnel Service (LTS).
  • compute: Lindorm Distributed Processing System (LDPS).
lindorm
Specificationstring

The specification of the engine node.

lindorm.g.2xlarge
MemorySizestring

The memory size of the engine nodes.

8GB
IsLastVersionboolean

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

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

The latest version number of the engine.

2.2.19.2
EnableComputeboolean

Indicates whether the instance's compute engine is enabled, returning:

  • true: Enabled.
  • false: Not enabled.
true
EnableSSLboolean

Indicates whether SSL link encryption is enabled, returning:

  • true: Enabled.
  • false: Disabled.
false
EnableMLCtrlboolean

Indicates whether AI control nodes are enabled for the instance.

  • True: AI control nodes are enabled for the instance.
  • False: AI control nodes are not enabled for the instance.
False
EnableCdcboolean

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

  • true: Enabled.
  • false: Not enabled.
false
EnableStreamboolean

Indicates whether the instance has the stream engine enabled. Return values:

  • true: Stream engine is enabled.
  • false: Stream engine is not enabled.
true
EnableLTSboolean

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

  • true: The LTS engine is activated for the instance.
  • false: The LTS engine is not activated for the instance.
true
EnableShsboolean

Whether to enable the Compute Engine History Server.

true
EnableBlobboolean

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

true: LBlob is enabled for the instance. false: LBlob is not enabled for the instance.

true
MaintainStartTimestring

Maintainable start time.

00:00Z
MaintainEndTimestring

Maintainable end time.

20:00Z
ResourceGroupIdstring

Resource group ID.

rg-aek2wvd6oia****
PrimaryZoneIdstring

Multi-zone instance, availability zone ID of the primary zone.

cn-shanghai-e
StandbyZoneIdstring

Multi-zone instance, backup availability zone's availability zone ID.

cn-shanghai-f
ArbiterZoneIdstring

Multi-zone instance, coordinating Availability Zone ID.

cn-shanghai-g
PrimaryVSwitchIdstring

Multi-zone instance, the virtual switch ID of the primary availability zone, which must be in the availability zone corresponding to PrimaryZoneId.

vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchIdstring

Multi-zone instance, the virtual switch ID of the backup availability zone, which must be in the availability zone corresponding to StandbyZoneId.

vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchIdstring

Multi-AZ instance, coordinating Availability Zone virtual switch ID, which must be located in the Availability Zone corresponding to ArbiterZoneId.

vsw-uf6664pqjawb87k36****
MultiZoneCombinationstring

Multi-zone combinations. For support details on zone combinations, please refer to the product page.

  • ap-southeast-5abc-aliyun: Indonesia (Jakarta) A+B+C.
  • cn-hangzhou-ehi-aliyun: East China 1 (Hangzhou) E+H+I.
  • cn-beijing-acd-aliyun: North China 2 (Beijing) A+C+D.
  • ap-southeast-1-abc-aliyun: Singapore A+B+C.
  • cn-zhangjiakou-abc-aliyun: North China 3 (Zhangjiakou) A+B+C.
  • cn-shanghai-efg-aliyun: East China 2 (Shanghai) E+F+G.
  • cn-shanghai-abd-aliyun: East China 2 (Shanghai) A+B+D.
  • cn-hangzhou-bef-aliyun: East China 1 (Hangzhou) B+E+F.
  • cn-hangzhou-bce-aliyun: East China 1 (Hangzhou) B+C+E.
  • cn-beijing-fgh-aliyun: North China 2 (Beijing) F+G+H.
  • cn-shenzhen-abc-aliyun: South China 1 (Shenzhen) A+B+C.
cn-shanghai-efg-aliyun
CoreDiskCategorystring

The disk type of the core nodes. This parameter is returned only for multi-zone instances. Valid values:

  • cloud_efficiency: This instance uses the Standard type of storage.
  • cloud_ssd: This instance uses the Performance type of storage.
  • cloud_essd: This instance uses ESSDs for storage.
  • cloud_essd_pl0: This instance uses PL0 ESSDs for storage.
cloud_efficiency
CoreSpecstring

Multi-zone instance, core node specification.

lindorm.g.xlarge
CoreNuminteger

Multi-zone instance, number of core nodes.

4
CoreSingleStorageinteger

Multi-zone instance, core single-node disk capacity.

400
LogDiskCategorystring

Multi-zone instance, log node disk type, returns:

  • cloud_efficiency: Standard cloud storage.
  • cloud_ssd: Performance cloud storage.
cloud_ssd
LogSpecstring

Multi-zone instance, log node specification.

lindorm.sn1.large
LogNuminteger

Multi-zone instance, number of log nodes.

4
LogSingleStorageinteger

The storage capacity of the disk of a single log node. This parameter is returned only for multi-zone instances.

400GB
ArchVersionstring

The architecture of the instance. Valid values:

  • 1.0: The instance is deployed in a single zone.
  • 2.0: The instance is deployed across multiple zones.
1.0
EnableLsqlVersionV3boolean

Indicates whether LindormTable of the instance supports LindormSQL V3 that is compatible with MySQL. By default, LindormTable of instances that are purchased after October 24, 2023 supports LindormSQL V3. If your instance is purchased before this date and want to enable LindormSQL V3, contact the technical support.

  • True: LindormTable supports LindormSQL V3.
  • False: LindormTable does not support LindormSQL V3.
True
EnableLProxyboolean

Indicates whether LindormTable supports the Thrift and CQL protocols. If these protocols are not supported. You can call the SwitchLProxyService operation to enable or disable the support on these protocols for LindormTable.

True: LindormTable supports the Thrift and CQL protocols.

False: LindormTable does not support the Thrift and CQL protocols.

False

description

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ],
  "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 codeError codeError messageDescription
400Instance.IsDeletedThe instance is deleted.-
400Instance.IsNotValidThe instance is invalid.The specified instance is invalid.
403Lindorm.Errorcode.OperationDeniedYou are not authorized to operate on the specified resource.-
403API.ForbiddenThe API operation is forbidden in this environment.This operation is not supported in the current environment.
403Lindorm.Errorcode.ServiceLinkedRoleNoPermissionNo permission to create service linked role.You are not authorized to create the service-linked role.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-03-18The Error code has changed. The response structure of the API has changedView Change Details
2024-10-11The Error code has changed. The response structure of the API has changedView Change Details
2024-06-05The Error code has changed. The response structure of the API has changedView Change Details
2023-11-15The Error code has changedView Change Details
2023-09-27The Error code has changed. The response structure of the API has changedView Change Details
2023-08-08The Error code has changed. The response structure of the API has changedView Change Details
2023-07-03The Error code has changed. The response structure of the API has changedView Change Details
2023-07-03The Error code has changed. The response structure of the API has changedView Change Details
2023-06-20The Error code has changed. The response structure of the API has changedView Change Details
2023-05-23The Error code has changed. The response structure of the API has changedView Change Details
2023-04-14The Error code has changed. The response structure of the API has changedView Change Details
2022-10-14The Error code has changed. The response structure of the API has changedView Change Details
2022-07-13The Error code has changed. The request parameters of the API has changedView Change Details
2021-10-14The Error code has changed. The response structure of the API has changedView Change Details
2021-10-14The Error code has changed. The response structure of the API has changedView Change Details