DocsICP FilingConsole
Documentation

GetLindormInstanceEngineList

Updated at:
Copy as MD
Product
My Favorites

Queries the engine types that a Lindorm instance supports.

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

get

*instance

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

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

No

The region ID.

cn-hangzhou
InstanceId

string

Yes

The ID of the instance. To obtain the instance ID, call the GetLindormInstanceList operation.

ld-bp1nq34mv3smk****

Response elements

Element

Type

Description

Example

object

InstanceId

string

The instance ID.

ld-bp1nq34mv3smk****
RequestId

string

The request ID.

B496BA0E-520C-59FC-BA04-196D8F3B07EF
EngineList

array<object>

The list of engine types.

array<object>

EngineType

string

The engine type. Valid values:

  • lindorm: LindormTable.

  • tsdb: LindormTSDB.

  • solr: Search engine.

  • store: File engine.

lindorm
NetInfoList

array<object>

The list of database connection information for the engine.

object

AccessType

integer

The connection method for LindormTable. Valid values:

  • 0: This is the default value and can be ignored.

  • 1: Use the HBase Java API to access LindormTable.

  • 2: Use a non-Java HBase API to access LindormTable.

  • 3: Use CQL to access LindormTable.

  • 4: Use the LindormTable SQL endpoint.

  • 5: Use the S3-compatible endpoint for LindormTable.

  • 6: Use the MySQL-compatible endpoint for LindormTable.

1
Port

integer

The port number of the database endpoint.

30020
ConnectionString

string

The database endpoint.

ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com
NetType

string

The network type of the database endpoint. Valid values:

  • 0: Internet.

  • 2: Virtual private cloud (VPC).

2
AccessDeniedDetail

string

The detailed reason why the access was denied.

{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "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"
        }
      ]
    }
  ],
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.