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

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 region ID of the instance. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
QueryStr	string	No	The keyword of the instance name. Fuzzy match is supported.	test
PageNumber	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries per page for a paged query.	20
ServiceType	string	No	The instance type. Valid values: lindorm: a Lindorm single-zone instance. lindorm_multizone: a Lindorm multi-zone instance. serverless_lindorm: a Lindorm Serverless instance. lindorm_standalone: a Lindorm single-node instance. lts: a Lindorm Tunnel Service instance.	lindorm
SupportEngine	integer	No	The type of data engine supported by the queried instance. Valid values: 1: The search index engine is supported. 2: LindormTSDB is supported. 4: LindormTable is supported. 8: The file engine is supported. Note For example, if SupportEngine is set to 15, which equals 8+4+2+1, the instance supports the search index engine, LindormTSDB, LindormTable, and the file engine. If SupportEngine is set to 6, which equals 4+2, the instance supports LindormTSDB and LindormTable.	15
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key. Valid values of N: 1 to 20. Note You can specify multiple tag keys. For example, the Key in the first pair specifies the first tag key, and the Key in the second pair specifies the second tag key.	test
Value	string	No	The tag value. Valid values of N: 1 to 20. Note You can specify multiple tag values. For example, the Value in the first pair specifies the first tag value, and the Value in the second pair specifies the second tag value.	2.2.18
ResourceGroupId	string	No	The resource group ID.	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 per page.	20
Total	integer	The total number of instances returned.	1
InstanceList	array<object>	The list of instances.
	array<object>
VpcId	string	The VPC ID of the instance.	vpc-bp1n3i15v90el48nx****
EngineType	string	The engine types supported by the instance. The return value is the sum of the following engine type values: 1: search index. 2: LindormTSDB. 4: LindormTable. 8: search engine. Note For example, if EngineType is 15 (15 = 8 + 4 + 2 + 1), the instance supports search index, LindormTSDB, LindormTable, and search engine. If EngineType is 6 (6 = 4 + 2), the instance supports LindormTSDB and LindormTable.	15
ExpireTime	string	The expiration time of the instance, in the yyyy-MM-dd HH:mm:ss format. Note This parameter is returned only when the billing method of the instance is subscription.	2022-04-26 00:00:00
CreateTime	string	The time when the instance was created, in the yyyy-MM-dd HH:mm:ss format.	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 Lindorm single-node instance. lts: a Lindorm Tunnel Service instance.	lindorm
RegionId	string	The region ID.	cn-hangzhou
CreateMilliseconds	integer	The time elapsed in milliseconds between the instance creation time and 1970-01-01 00:00:00.	1631772842000
InstanceAlias	string	The instance name.	test
ZoneId	string	The zone ID.	cn-hangzhou-h
InstanceStatus	string	The instance status. Valid values: CREATING: being created. ACTIVATION: running. COLD_EXPANDING: storage expansion of storage-optimized cloud storage in progress. MINOR_VERSION_TRANSING: minor version upgrade in progress. RESIZING: scaling out nodes. SHRINKING: scaling in nodes. CLASS_CHANGING: upgrade or decrease the quota of specifications in progress. SSL_SWITCHING: changing SSL settings. CDC_OPENING: enabling the data subscribe feature. TRANSFER: data migration in progress. DATABASE_TRANSFER: data migration to a database in progress. GUARD_CREATING: creating a disaster recovery instance. BACKUP_RECOVERING: restoring from a backup. DATABASE_IMPORTING: data import in progress. NET_MODIFYING: changing the network. NET_SWITCHING: switching between internal network and public network. NET_CREATING: creating a network connection. NET_DELETING: deleting a network connection. DELETING: being deleted. RESTARTING: restarting. LOCKED: locked because the instance expires.	ACTIVATION
ExpiredMilliseconds	integer	The time elapsed in milliseconds between the time when the instance expires and 1970-01-01 00:00:00.	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 tags.
	object
Key	string	The tag key.	test
Value	string	The tag value.	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 resource group ID.	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 the LindormTable 3.0 engine is enabled. Valid values: true: Enabled. false: Not enabled.	true
CreateErrorCode	string	The error code for the creation failure.	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.