GetLindormInstanceList - Lindorm - Alibaba Cloud Documentation Center

Queries the instances that meet the specified conditions.

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:GetLindormInstanceList	READ	Lindorm acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which the instances you want to query are located. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
QueryStr	string	No	The keyword contained in the names of Lindorm instances you want to query. Fuzzy queries based on the keyword is supported.	test
PageNumber	integer	Yes	The number of the pages to return,	1
PageSize	integer	Yes	The number of instances to return on each page.	20
ServiceType	string	No	The series of instances that you want to query. Valid values: lindorm: The instance is a single-zone Lindorm instance. lindorm_multizone: The instance is a multi-zone Lindorm instance. serverless_lindorm: The instance is a Lindorm Serverless instance. lindorm_standalone: The instance is a single-node Lindorm instance. lts: The instance is an LTS instance.	lindorm
SupportEngine	integer	No	The engine supported by the instances that you want to query. 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 you set the value of this parameter to 15, which is the sum of 1, 2, 4, and 8, this operation queries instances that support all four engines. If you set the value of this parameter to 6, which is the sum of 2 and 4, this operation queries instances that support LindormTSDB and LindormTable.	15
Tag	array	No	The list of tags that are associated with the instances.
	object	No	The tags of the instance.
Key	string	No	The keys of the tags associated with the instances you want to query. You can specify 1 to 20 tag keys. NoteYou can specify the keys of multiple tags. For example, you can specify the key of the first tag in the first key-value pair contained in the value of this parameter and specify the key of the second tag in the second key-value pair.	test
Value	string	No	The values of the tags associated with the instances you want to query. You can specify 1 to 20 tag values. NoteYou can specify the values of multiple tags. For example, you can specify the value of the first tag in the first key-value pair contained in the value of this parameter and specify the value of the second tag in the second key-value pair.	2.2.18
ResourceGroupId	string	No	The ID of the resource group to which the instances you want to query belong.	rg-aek3b63arvg27vi

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber	integer	The number of returned pages.	1
PageSize	integer	The number of instances that are returned on each page.	20
Total	integer	The total number of returned instances.	1
InstanceList	array	The list of returned instances.
	object
VpcId	string	The ID of the VPC in which the instance is deployed.	vpc-bp1n3i15v90el48nx****
EngineType	string	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. NoteThis parameter is returned only if the billing method of the instance is subscription.	2022-04-26 00:00:00
CreateTime	string	The time when the instance is created.	2021-09-16 14:13:13
PayType	string	The billing method of the instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go	PREPAY
AliUid	long	The 16-digit AliUid of the Alibaba Cloud account that owns the instance.	164901546557****
InstanceStorage	string	The storage capacity of the instance.	960
InstanceId	string	The ID of the instance.	ld-bp17pwu1541ia****
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_standalone: The instance is a single-node Lindorm instance. lts: The instance is an LTS instance.	lindorm
RegionId	string	The region ID.	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.	1631772842000
InstanceAlias	string	The name of the VPC.	test
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 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
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.	1650902400000
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
Tags	array	The tags associated with the instance.
	object
Key	string	The key of the tag associated with the instance.	test
Value	string	The value of the tag associated with the instance.	2.2.18
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
ResourceGroupId	string	The ID of the resource group.	rg-aekzledqeat****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1,
  "InstanceList": [
    {
      "VpcId": "vpc-bp1n3i15v90el48nx****",
      "EngineType": "15",
      "ExpireTime": "2022-04-26 00:00:00",
      "CreateTime": "2021-09-16 14:13:13",
      "PayType": "PREPAY",
      "AliUid": 0,
      "InstanceStorage": "960",
      "InstanceId": "ld-bp17pwu1541ia****",
      "NetworkType": "vpc",
      "ServiceType": "lindorm",
      "RegionId": "cn-hangzhou",
      "CreateMilliseconds": 1631772842000,
      "InstanceAlias": "test",
      "ZoneId": "cn-hangzhou-h",
      "InstanceStatus": "ACTIVATION",
      "ExpiredMilliseconds": 1650902400000,
      "EnableStream": true,
      "Tags": [
        {
          "Key": "test",
          "Value": "2.2.18"
        }
      ],
      "EnableCompute": true,
      "ResourceGroupId": "rg-aekzledqeat****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.

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

Change history

Change time	Summary of changes	Operation

No change history