Retrieve Lindorm Instance List with GetLindormInstanceList - Lindorm - Alibaba Cloud - Lindorm

Queries 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 DescribeRegions to obtain the region ID.	cn-hangzhou
QueryStr	string	No	A keyword for a fuzzy search on instance names.	test
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries to return on each page for a paged query.	20
ServiceType	string	No	The type of the instance. Valid values: lindorm: a single-zone Lindorm instance. lindorm_multizone: a multi-zone Lindorm instance. serverless_lindorm: a Lindorm Serverless instance. lindorm_standalone: a Lindorm standalone instance. lts: the Lindorm Tunnel Service (LTS) type.	lindorm
SupportEngine	integer	No	The type of the engine supported by the instance that you want to query. Valid values: 1: search engine. 2: LindormTSDB. 4: LindormTable. 8: file engine. Note For example, a value of 15 (8 + 4 + 2 + 1) indicates that the instance supports the file engine, LindormTable, LindormTSDB, and the search engine. A value of 6 (4 + 2) indicates that the instance supports LindormTSDB and LindormTable.	15
Tag	array<object>	No	A list of tags. You can specify up to 20 tags.
	object	No	A list of tags.
Key	string	No	The key of the tag. Note You can pass in keys for multiple tags. For example, the Key in the first pair represents the key for the first tag. The Key in the second pair represents the key for the second tag.	test
Value	string	No	The value of the tag. Note You can provide values for multiple tags. For example, the Value in the first pair is the value for the first tag. The Value in the second pair is the value for 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 ID of the request.	1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on the 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) in which the instance is deployed.	vpc-bp1n3i15v90el48nx****
EngineType	string	The types of engines supported by the instance. The value of this parameter is the sum of the values of the supported engines. 1: search engine. 2: LindormTSDB. 4: LindormTable. 8: file engine. Note For example, a value of 15 (8 + 4 + 2 + 1) indicates that the instance supports the file engine, LindormTable, LindormTSDB, and the search engine. A value of 6 (4 + 2) indicates that the instance supports LindormTSDB and LindormTable.	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 ID of the Alibaba Cloud account.	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 type of the instance. Valid values: lindorm: a Lindorm instance. serverless_lindorm: a Lindorm Serverless instance. lindorm_standalone: a Lindorm standalone instance. lts: the Lindorm Tunnel Service type.	lindorm
RegionId	string	The ID of the region.	cn-hangzhou
CreateMilliseconds	integer	The timestamp of when the instance was created. The value is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1631772842000
InstanceAlias	string	The name of the instance.	test
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 storage-optimized instance is being expanded. MINOR_VERSION_TRANSING: The minor version of the instance is being upgraded. RESIZING: The instance is scaling up. SHRINKING: The instance is scaling down. CLASS_CHANGING: The instance class is being changed. SSL_SWITCHING: The SSL certificate is being changed. CDC_OPENING: The data subscription feature is being enabled. TRANSFER: Data migration is in progress. DATABASE_TRANSFER: Data is being migrated to the database. GUARD_CREATING: A disaster recovery instance is being created. BACKUP_RECOVERING: A backup is being restored. DATABASE_IMPORTING: Data is being imported. NET_MODIFYING: The network settings are being modified. NET_SWITCHING: The network type 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 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 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 messaging 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 the LindormTable 3.0 engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
CreateErrorCode	string	The reason why the instance failed to be created.	Resource is not enough

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": "Resource is not enough"
    }
  ]
}

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.