GetLindormInstance-阿里云帮助中心

Retrieves detailed information about a Lindorm instance, including its 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. Call GetLindormInstanceList to obtain the 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 at which 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 type of the instance. Valid values: lindorm: a single-zone instance. lindorm_multizone: a multi-zone instance. serverless_lindorm: a serverless instance. lindorm_standalone: a single-node 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. Valid values: cloud_efficiency: Standard. cloud_ssd: Performance. cloud_essd: Enhanced SSD (ESSD). cloud_essd_pl0: ESSD PL0. capacity_cloud_storage: Capacity. 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	The capacity of the cold storage.	0GB
ArchiveStorage	integer	The billable storage capacity of the archive storage. Unit: GB.	0GB
ExpiredMilliseconds	integer	The expiration time of the instance. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1629993600000
EngineType	integer	The types of the engines that are supported by the instance. The value of this parameter is the sum of the values of all supported engine types. 1: search engine 2: time series engine 4: wide table engine 8: file engine Note For example, if the value of this parameter is 15, it indicates that the instance supports the search, time series, wide table, and file engines because 1 + 2 + 4 + 8 = 15. If the value of this parameter is 6, it indicates that the instance supports the time series and wide table engines because 2 + 4 = 6.	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 for subscription instances.	2021-08-27 00:00:00
AutoRenew	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Enabled. false: Disabled. Note This parameter is returned only for subscription instances.	false
DeletionProtection	string	Indicates whether release protection is enabled for the instance. Valid values: true: Enabled. false: Disabled.	false
InstanceStorage	string	The storage capacity of the instance.	480
AliUid	integer	The UID of the Alibaba Cloud account.	164901546557****
InstanceId	string	The ID of the instance.	ld-bp1o3y0yme2i2****
RegionId	string	The ID of the region.	cn-hangzhou
CreateMilliseconds	integer	The time at which the instance was created. This value is a UNIX timestamp representing 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 ID of the zone.	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 of the cold storage is being expanded. MINOR_VERSION_TRANSITIONING: The minor version of the instance is being changed. RESIZING: The number of nodes is being changed. SHRINKING: The number of nodes is being changed. CLASS_CHANGING: The specification of the instance is being changed. SSL_SWITCHING: SSL is being enabled or disabled. CDC_OPENING: The CDC feature is being enabled. TRANSFER: Data is being migrated. DATABASE_TRANSFER: Data is being migrated. 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 type is being changed. NET_SWITCHING: The network is being switched. 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 is locked.	ACTIVATION
EngineList	array<object>	The information about the engines.
	object	The information about the engines.
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: the wide table engine. tsdb: the time series engine. solr: the search engine. store: the file engine. bds: the LTS engine. compute: the compute engine.	lindorm
Specification	string	The specification of the engine nodes.	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	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 ML node is enabled. Valid values: true: Enabled. false: Disabled.	False
EnableCdc	boolean	Indicates whether Change Data Capture (CDC) 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: Enabled. false: Disabled.	true
EnableLTS	boolean	Indicates whether the LTS engine is enabled for the instance. Valid values: true: Enabled. false: Disabled.	true
EnableShs	boolean	Indicates whether the History Server is enabled for the compute engine.	true
EnableBlob	boolean	Indicates whether LBlob is enabled. Valid values: true: Enabled. false: 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 ID of the resource group.	rg-aek2wvd6oia****
PrimaryZoneId	string	The primary zone ID of the multi-zone instance.	cn-shanghai-e
StandbyZoneId	string	The secondary zone ID of the multi-zone instance.	cn-shanghai-f
ArbiterZoneId	string	The arbiter zone ID of 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 deployed 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 deployed 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 deployed in the zone that is specified by `ArbiterZoneId`.	vsw-uf6664pqjawb87k36****
MultiZoneCombination	string	The combination of zones. For more information about the supported zone combinations, see the instance buy page. ap-southeast-5abc-aliyun: Indonesia (Jakarta) Zone A, B, and C. cn-hangzhou-ehi-aliyun: China (Hangzhou) Zone E, H, and I. cn-beijing-acd-aliyun: China (Beijing) Zone A, C, and D. ap-southeast-1-abc-aliyun: Singapore Zone A, B, and C. cn-zhangjiakou-abc-aliyun: China (Zhangjiakou) Zone A, B, and C. cn-shanghai-efg-aliyun: China (Shanghai) Zone E, F, and G. cn-shanghai-abd-aliyun: China (Shanghai) Zone A, B, and D. cn-hangzhou-bef-aliyun: China (Hangzhou) Zone B, E, and F. cn-hangzhou-bce-aliyun: China (Hangzhou) Zone B, C, and E. cn-beijing-fgh-aliyun: China (Beijing) Zone F, G, and H. cn-shenzhen-abc-aliyun: China (Shenzhen) Zone A, B, and C.	cn-shanghai-efg-aliyun
CoreDiskCategory	string	The disk type of the core nodes in a multi-zone instance. Valid values: cloud_efficiency: Standard. cloud_ssd: Performance. cloud_essd: ESSD. cloud_essd_pl0: ESSD PL0.	cloud_efficiency
CoreSpec	string	The specification of the core nodes in the multi-zone instance.	lindorm.g.xlarge
CoreNum	integer	The number of core nodes in the multi-zone instance.	4
CoreSingleStorage	integer	The storage capacity of a single core node in the multi-zone instance.	400
LogDiskCategory	string	The disk type of the log nodes in the multi-zone instance. Valid values: cloud_efficiency: Standard. cloud_ssd: Performance.	cloud_ssd
LogSpec	string	The specification of the log nodes in the multi-zone instance.	lindorm.sn1.large
LogNum	integer	The number of log nodes in the multi-zone instance.	4
LogSingleStorage	integer	The storage capacity of a single log node in the multi-zone instance.	400GB
BackupInstance	string	The ID of the backup instance.	ld-xxxx
EnableLsqlVersionV3	boolean	Indicates whether LindormSQL V3.0, which is compatible with the MySQL protocol, is supported by the wide table engine. This feature is supported by default on instances created after October 24, 2023. For existing instances, contact technical support to enable this feature. true: Supported. false: Not supported.	True
EnableLProxy	boolean	Specifies whether the wide table engine supports the Thrift and CQL protocols. If this feature is disabled, you can call the SwitchLProxyService operation to enable it. true: Supported. false: Not supported.	False
ArchVersion	string	The deployment architecture. Valid values: 1.0: single-zone deployment. 2.0: multi-zone deployment.	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": "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"
}

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.