GetLindormInstanceList - Lindorm - Alibaba Cloud Documentation Center

Retrieves a list of Lindorm instances.

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:GetLindormInstanceList

get

*Instance

acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the instance is located. Call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
QueryStr	string	No	A keyword for fuzzy search of instance names.	test
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries to return on each page.	20
ServiceType	string	No	The instance type. Valid values: lindorm: a single-zone Lindorm instance. lindorm_multizone: a multi-zone Lindorm instance. serverless_lindorm: a Lindorm Serverless instance. lindorm_standalone: a standalone Lindorm instance. lts: the Lindorm Tunnel Service (LTS) type.	lindorm
SupportEngine	integer	No	The data engine types supported by the instances that you want to query. Valid values: 1: Search Engine. 2: Time Series Engine. 4: Wide Table Engine. 8: File Engine. Note For example, if you set SupportEngine to 15, which is the sum of 8, 4, 2, and 1, the instance supports the Search Engine, Time Series Engine, Wide Table Engine, and File Engine. If you set SupportEngine to 6, which is the sum of 4 and 2, the instance supports the Time Series Engine and Wide Table Engine.	15
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The key of the tag. The value of N can be from 1 to 20. Note You can specify the keys of multiple tags. For example, the first `Key` parameter specifies the key of the first tag, and the second `Key` parameter specifies the key of the second tag.	test
Value	string	No	The value of the tag. The value of N can be from 1 to 20. Note You can specify the values of multiple tags. For example, the first `Value` parameter specifies the value of the first tag, and the second `Value` parameter specifies the value of the second tag.	2.2.18
ResourceGroupId	string	No	The ID of the resource group.	rg-aek3b63arvg27vi

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on the current page.	20
Total	integer	The total number of instances found.	1
InstanceList	array<object>	The list of instances.
	array<object>
VpcId	string	The ID of the virtual private cloud (VPC) to which the instance belongs.	vpc-bp1n3i15v90el48nx****
EngineType	string	The types of engines supported by the instance. The return value is the sum of 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 the value of EngineType is 15, which is the sum of 8, 4, 2, and 1, the instance supports the Search Engine, Time Series Engine, Wide Table Engine, and File Engine. If the value of EngineType is 6, which is the sum of 4 and 2, the instance supports the Time Series Engine and Wide Table Engine.	15
ExpireTime	string	The expiration time of the instance. Note This parameter is returned only for subscription instances.	2022-04-26 00:00:00
CreateTime	string	The time when the instance was 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	integer	The 16-digit AliUid of the Alibaba Cloud account.	164901546557****
InstanceStorage	string	The storage capacity of the instance.	960
InstanceId	string	The instance ID.	ld-bp17pwu1541ia****
NetworkType	string	The network type of the instance.	vpc
ServiceType	string	The instance type. Valid values: lindorm: a Lindorm instance. serverless_lindorm: a Lindorm Serverless instance. lindorm_standalone: a standalone Lindorm instance. lts: the Lindorm Tunnel Service type.	lindorm
RegionId	string	The region ID.	cn-hangzhou
CreateMilliseconds	integer	The timestamp of when the instance was created. The value is the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1631772842000
InstanceAlias	string	The instance name.	test
ZoneId	string	The zone ID.	cn-hangzhou-h
InstanceStatus	string	The instance status. Valid values: CREATING: The instance is being created. ACTIVATION: The instance is running. COLD_EXPANDING: The storage-optimized cloud storage is being expanded. MINOR_VERSION_TRANSING: The minor version is being upgraded. RESIZING: The nodes are being scaled out. SHRINKING: The nodes are being scaled in. CLASS_CHANGING: The instance is being upgraded or downgraded. SSL_SWITCHING: The SSL certificate is being changed. CDC_OPENING: The change tracking feature is being enabled. TRANSFER: Data is being migrated. DATABASE_TRANSFER: Data is being migrated to the database. 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 is being changed. NET_SWITCHING: The network is being switched between the internal network and the internet. 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 has expired and is locked.	ACTIVATION
ExpiredMilliseconds	integer	The timestamp of when the instance expires. The value is the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1650902400000
EnableStream	boolean	Indicates whether the stream engine is enabled for the instance. Valid values: true: The stream engine is enabled. false: The stream engine is not enabled.	true
Tags	array<object>	The list of tags.
	object
Key	string	The key of the tag.	test
Value	string	The value of the tag.	2.2.18
EnableCompute	boolean	Indicates whether the compute engine is enabled for the instance. Valid values: true: Enabled. false: Not enabled.	true
ResourceGroupId	string	The ID of the resource group.	rg-aekzledqeat****
EnableMessage	boolean	Indicates whether the message engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
EnableVector	boolean	Indicates whether the vector engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
EnableLts	boolean	Indicates whether the LTS engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
EnableColumn	boolean	Indicates whether the column store engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
EnableRow	boolean	Indicates whether Wide Table Engine 3.0 is enabled. Valid values: true: Enabled. false: Not enabled.	true
CreateErrorCode	string

Examples

Success response

JSON format

{
  "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****",
      "EnableMessage": true,
      "EnableVector": true,
      "EnableLts": true,
      "EnableColumn": true,
      "EnableRow": true,
      "CreateErrorCode": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.IsDeleted	The instance is deleted.	The specified instance is already deleted.
400	Instance.IsNotAvailable	The instance is unavailable.	The specified instance is unavailable.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.