GetLindormInstanceEngineList - Lindorm - Alibaba Cloud Documentation Center

Queries the engines that can run on the specified 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:GetLindormInstanceEngineList	READ	Lindorm acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region in which the instance you want to query is located.	cn-hangzhou
InstanceId	string	Yes	The ID of the instance whose engines you want to query. You can call the GetLindormInstanceList operation to query the instance ID.	ld-bp1nq34mv3smk****

Response parameters

Parameter	Type	Description	Example
	object
InstanceId	string	The ID of the instance that you want to query.	ld-bp1nq34mv3smk****
RequestId	string	The ID of the request.	B496BA0E-520C-59FC-BA04-196D8F3B07EF
EngineList	array	The list of engines that can run on the specified instance.
	object
EngineType	string	The type of engine that can run on the instance. Valid values: lindorm: LindormTable. tsdb: LindormTSDB. solr: LindormSearch. store: LindormDFS.	lindorm
NetInfoList	array	The list of connection information about the engine.
	object
AccessType	integer	The method by which the connection information can be used to access LindormTable. Valid values: 1: The connection information can be used by ApsaraDB for HBase API for Java to access LindormTable. 2: The connection information can be used by ApsaraDB for HBase API for a non-Java language to access LindormTable. 3: The connection information can be used by the Cassandra Query Language (CQL) to access LindormTable. 4: The connection information can be used by the Lindorm SQL API to access LindormTable.	1
Port	integer	The port number used to connect to the engine.	30020
ConnectionString	string	The endpoint that is used to connect to the engine.	ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: 0: Internet 2: virtual private cloud (VPC)	2

Examples

Sample success responses

JSONformat

{
  "InstanceId": "ld-bp1nq34mv3smk****",
  "RequestId": "B496BA0E-520C-59FC-BA04-196D8F3B07EF",
  "EngineList": [
    {
      "EngineType": "lindorm",
      "NetInfoList": [
        {
          "AccessType": 1,
          "Port": 30020,
          "ConnectionString": "ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com",
          "NetType": "2"
        }
      ]
    }
  ]
}

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.IsNotValid	The instance is invalid.	The specified instance is invalid.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.	You are not authorized to manage the specified resource.
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.