GetLindormInstance - Lindorm - Alibaba Cloud Documentation Center

Queries the detailed information about a specified Lindorm instance.

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Association operation
lindorm:GetLindormInstance	READ	Lindorm acs:lindorm::{#accountId}: Lindorm acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance of which the information you want to query. You can call the GetLindormInstanceList operation to query the instance ID.	ld-bp1o3y0yme2i2****

Response parameters

Parameter	Type	Description	Example
	object
VpcId	string	The ID of the VPC in which the instance is deployed.	vpc-bp1n3i15v90el48nx****
VswitchId	string	The ID of the vSwitch to which the instance connects.	vsw-bp1vbjzmod9q3l9eo****
CreateTime	string	The time when the instance is created. The time is 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 series of the instance. Valid values: lindorm: The instance is a Lindorm instance serverless_lindorm: The instance is a Lindorm Serverless instance.	lindorm
EnableKms	boolean	Indicates whether Key Management Service (KMS) is enabled for the instance. Valid values: true: KMS is enabled for the instance. false: KMS is not enabled for the instance.	false
DiskUsage	string	The storage usage of the instance.	0.0%
DiskCategory	string	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. capacity_cloud_storage: This instance uses the Capacity type of storage. local_ssd_pro: This instance uses local SSDs. local_hdd_pro: This instance uses local HDDs.	cloud_efficiency
RequestId	string	The ID of the request.	633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
ColdStorage	integer	The cold storage capacity of the instance.	0
ExpiredMilliseconds	long	The time when the instance expires. This value is a UNIX timestamp that indicates the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1629993600000
EngineType	integer	The engine supported by the instance. The engines are indicated by different numbers: 1: LindormSearch. 2: LindormTSDB. 4: LindormTable. 8: LindormDFS. NoteThe value of this parameter is the sum of all numbers that indicate the engines supported by the instance. For example, if the value of this parameter is 15, which is the sum of 1, 2, 4, and 8, the instance supports all four engines. If the value of this parameter is 6, which is the sum of 2 and 4, the instance supports LindormTSDB and LindormTable.	15
ExpireTime	string	The time when the instance expires. The time is in the yyyy-MM-dd HH:mm:ss format. NoteThis parameter is returned only if the billing method of the instance is subscription.	2021-08-27 00:00:00
AutoRenew	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance. NoteThis parameter is returned only if the billing method of the instance is subscription.	false
DeletionProtection	string	Indicates whether deletion protection is enabled. Valid values: true: Deletion protection is enabled for the instance. false: Deletion protection is not enabled for the instance.	false
InstanceStorage	string	The storage capacity of the instance.	480
AliUid	long	The 16-bit AliUid of the user.	1000000000000000
InstanceId	string	The ID of the instance.	ld-bp1o3y0yme2i2****
RegionId	string	The ID of the region in which the instance is located.	cn-hangzhou
CreateMilliseconds	long	The time when the instance is created. This value is a UNIX timestamp that indicates the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1627290664000
InstanceAlias	string	The name of the instance.	test0726
DiskThreshold	string	The storage capacity threshold of the instance.	80%
ZoneId	string	The ID of the zone in which the instance is located.	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 cold storage of the instance is being scaled up. MINOR_VERSION_TRANSING: The minor version of the instance is being upgraded. 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
EngineList	array	The list of engines supported by the instance.
	object
Version	string	The version of the engine.	2.2.3
CpuCount	string	The number of CPU cores on the engine node.	4
CoreCount	string	The number of engine nodes.	2
Engine	string	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
MemorySize	string	The memory size of the engine nodes	8
IsLastVersion	boolean	Indicates whether the version of the engine is latest. Valid values: true: The version of the engine is the latest. false: The version of the engine is not the latest.	false
LatestVersion	string	The latest version number of the engine.	2.2.19.2
EnableCompute	boolean	Indicates whether LDPS is enabled for the instance. Valid values: true: LDPS is enabled for the instance. false: LDPS is not enabled for the instance.	true
EnableSSL	boolean	Indicates whether SSL encryption is enabled for the instance. Valid values: true: SSL encryption is enabled for the instance. false: SSL encryption is not enabled for the instance.	false
EnableCdc	boolean	Indicates whether data subscription is enabled for the instance. Valid values: true: Data subscription is enabled for the instance. false: Data subscription is not enabled for the instance.	false
EnableStream	boolean	Indicates whether the Lindorm streaming engine is enabled for the instance. Valid values: true: The Lindorm streaming engine is enabled for the instance. false: The Lindorm streaming engine is not enabled for the instance.	true
EnableShs	boolean	Indicates whether the history sever of LDFS is enabled for the instance.	true
MaintainStartTime	string	The start time of the maintenance window of the instance.	00:00Z
MaintainEndTime	string	The end time of the maintenance window of the instance.	20:00Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aek2wvd6oia4b2a
PrimaryZoneId	string	The primary zone ID of the instance. This parameter is returned only for multi-zone instances.	cn-shanghai-e
StandbyZoneId	string	The secondary zone ID of the instance. This parameter is returned only for multiple-zone instances.	cn-shanghai-f
ArbiterZoneId	string	The ID of the zone for the coordinate node of the instance. This parameter is returned only for multiple-zone instances.	cn-shanghai-g
PrimaryVSwitchId	string	The ID of the vSwitch that is specified for the primary zone. The vSwitch must be deployed in the zone specified by the PrimaryZoneId parameter. This parameter is returned only for multiple-zone instances.	vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchId	string	The ID of the vSwitch that is specified for the secondary zone. The vSwitch must be deployed in the zone specified by the StandbyZoneId parameter. This parameter is returned only for multiple-zone instances.	vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchId	string	The ID of the vSwitch that is specified for the zone for the coordinate node of the instance. The vSwitch must be deployed in the zone specified by the ArbiterZoneId parameter. This parameter is returned only for multiple-zone instances.	vsw-uf6664pqjawb87k36****
MultiZoneCombination	string	The combinations of zones that are available for the multi-zone instance. You can go to the purchase page of Lindorm to view the supported zone combinations. ap-southeast-5abc-aliyun: Zone A+B+C in the Indonesia (Jakarta) region. cn-hangzhou-ehi-aliyun: Zone E+H+I in the China (Hangzhou) region. cn-beijing-acd-aliyun: Zone A+C+D in the China (Beijing) region. ap-southeast-1-abc-aliyun: Zone A+B+C in the Singapore region. cn-zhangjiakou-abc-aliyun: Zone A+B+C in the China (Zhangjiakou) region. cn-shanghai-efg-aliyun: Zone E+F+G in the China (Shanghai) region. cn-shanghai-abd-aliyun: Zone A+B+D in the China (Shanghai) region, cn-hangzhou-bef-aliyun: Zone B+E+F in the China (Hangzhou) region. cn-hangzhou-bce-aliyun: Zone B+C+E in the China (Hangzhou) region. cn-beijing-fgh-aliyun: Zone F+G+H in the China (Beijing) region. cn-shenzhen-abc-aliyun: Zone A+B+C in the China (Shenzhen) region.	cn-shanghai-efg-aliyun
CoreDiskCategory	string	The disk type of the core 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. local_ssd_pro: The nodes use local SSDs. local_hdd_pro: The nodes use local HDDs.	cloud_efficiency
CoreSpec	string	The type of the core nodes. This parameter is returned only for multi-zone instances.	lindorm.g.xlarge
CoreNum	integer	The number of the core nodes. This parameter is returned only for multi-zone instances.	4
CoreSingleStorage	integer	The storage capacity of the disk of a single core node. This parameter is returned only for multi-zone instances.	400
LogDiskCategory	string	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.	cloud_ssd
LogSpec	string	The type of the log nodes. This parameter is returned only for multi-zone instances.	lindorm.sn1.large
LogNum	integer	The number of the log nodes. This parameter is returned only for multi-zone instances.	4
LogSingleStorage	integer	The storage capacity of the disk of a single log node. This parameter is returned only for multi-zone instances.	400

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,
  "DiskUsage": "0.0%",
  "DiskCategory": "cloud_efficiency",
  "RequestId": "633F1BE4-C8DA-5744-8FDF-A3075C3FE37F",
  "ColdStorage": 0,
  "ExpiredMilliseconds": 1629993600000,
  "EngineType": 15,
  "ExpireTime": "2021-08-27 00:00:00",
  "AutoRenew": false,
  "DeletionProtection": "false",
  "InstanceStorage": "480",
  "AliUid": 1000000000000000,
  "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",
      "MemorySize": "8",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2"
    }
  ],
  "EnableCompute": true,
  "EnableSSL": false,
  "EnableCdc": false,
  "EnableStream": true,
  "EnableShs": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "ResourceGroupId": "rg-aek2wvd6oia4b2a",
  "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": 400
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.	-
400	Instance.IsDeleted	The instance is deleted.	-
400	Instance.IsNotValid	The instance is invalid.	The specified instance is invalid.
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.

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

Change history

Change time

Summary of changes

Operation

2022-10-14

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
Output Parameters	The response structure of the API operation changes.

2022-07-13

The error codes of the API operation change.,The input parameters of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
Input Parameters	The input parameters of the API operation change.
	delete Input Parameters: RegionId

2021-10-14

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
Output Parameters	The response structure of the API operation changes.

2021-10-14

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
Output Parameters	The response structure of the API operation changes.