AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云原生多模数据库 Lindorm 开发参考 API参考 API目录 实例 GetLindormInstanceList - 获取Lindorm实例列表

GetLindormInstanceList - 获取Lindorm实例列表

更新时间：
产品详情
我的收藏

获取Lindorm实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

lindorm:GetLindormInstanceList

get

*Instance

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

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

实例所属的地域 ID，可调用 DescribeRegions 接口获取。

cn-hangzhou
QueryStr

string

否

实例名称关键字，可根据该关键字模糊搜索。

test
PageNumber

integer

否

指定要查询的页码。

1
PageSize

integer

否

指定分页查询时每页行数。

20
ServiceType

string

否

实例类型，取值：

  • lindorm：表示 Lindorm 单可用区实例。

  • lindorm_multizone：表示 Lindorm 多可用区实例。

  • serverless_lindorm：表示 Lindorm Serverless 实例。

  • lindorm_standalone：表示 Lindorm 单节点实例。

  • lts：表示 Lindorm 数据通道服务类型。

lindorm
SupportEngine

integer

否

查询的实例支持的数据引擎类型，取值：

  • 1：支持搜索引擎。

  • 2：支持时序引擎。

  • 4：支持宽表引擎。

  • 8：支持文件引擎。

说明

例如：SupportEngine 取值为 15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。SupportEngine 取值为 6，6=4+2，表示该实例支持时序引擎和宽表引擎。

15
Tag

array<object>

否

标签列表。

object

否

标签列表。

Key

string

否

标签的键。N 的取值范围：1~20。

说明

可以传入多个标签的键。例如：第一对中的 Key 表示传入第一个标签的键。第二对中的 Key 表示传入第二个标签的键。

test
Value

string

否

标签的值。N 的取值范围：1~20。

说明

可以传入多个标签的值。例如：第一对中的 Value 表示传入第一个标签的值。第二对中的 Value 表示传入第二个标签的值。

2.2.18
ResourceGroupId

string

否

资源组 ID。

rg-aek3b63arvg27vi

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber

integer

实例所在页码。

1
PageSize

integer

实例所在页的行数。

20
Total

integer

查询到的实例总数。

1
InstanceList

array<object>

实例列表。

object

VpcId

string

实例所属的专有网络 ID。

vpc-bp1n3i15v90el48nx****
EngineType

string

实例支持引擎的类型，返回值是由下列引擎类型的值做加法运算后得到的。

  • 1：支持搜索引擎。

  • 2：支持时序引擎。

  • 4：支持宽表引擎。

  • 8：支持文件引擎。

说明

例如：EngineType 值为 15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType 值为 6，6=4+2，表示该实例支持时序引擎和宽表引擎。

15
ExpireTime

string

实例的到期时间。

说明

实例的付费类型为包年包月，才会返回本参数。

2022-04-26 00:00:00
CreateTime

string

实例的创建时间。

2021-09-16 14:13:13
PayType

string

实例的付费类型，返回值：

  • PREPAY：包年包月。

  • POSTPAY：按量付费。

PREPAY
AliUid

integer

阿里云账号（主账号）的 16 位 AliUid。

164901546557****
InstanceStorage

string

实例的存储容量。

960
InstanceId

string

实例 ID。

ld-bp17pwu1541ia****
NetworkType

string

实例的网络类型。

vpc
ServiceType

string

实例类型，返回值：

  • lindorm：表示 Lindorm 实例。

  • serverless_lindorm：表示 LindormServerless 实例。

  • lindorm_standalone：表示 Lindorm 单节点实例。

  • lts：表示 Lindorm 数据通道服务类型。

lindorm
RegionId

string

地域 ID。

cn-hangzhou
CreateMilliseconds

integer

表示实例创建时间与 1970-01-01 00:00:00 之间的毫秒值。

1631772842000
InstanceAlias

string

实例名称。

test
ZoneId

string

可用区 ID。

cn-hangzhou-h
InstanceStatus

string

实例状态，返回值：

  • CREATING：创建中。

  • ACTIVATION：运行中。

  • COLD_EXPANDING：容量型云存储扩容中。

  • MINOR_VERSION_TRANSING：小版本升级中。

  • RESIZING：节点扩容中。

  • SHRINKING：节点缩容中。

  • CLASS_CHANGING：升级规格中或者降配规格中。

  • SSL_SWITCHING：SSL变更中。

  • CDC_OPENING：数据订阅功能开通中。

  • TRANSFER：数据迁移中。

  • DATABASE_TRANSFER：数据迁移至数据库中。

  • GUARD_CREATING：生产灾备实例中。

  • BACKUP_RECOVERING：备份恢复中。

  • DATABASE_IMPORTING：数据导入中。

  • NET_MODIFYING：网络变更中。

  • NET_SWITCHING：内网和外网切换中。

  • NET_CREATING：创建网络链接中。

  • NET_DELETING：删除网络链接中。

  • DELETING：删除中。

  • RESTARTING：重启中。

  • LOCKED：实例已过期，锁定中。

ACTIVATION
ExpiredMilliseconds

integer

实例到期时间与 1970-01-01 00:00:00 之间的毫秒值。

1650902400000
EnableStream

boolean

实例是否开通流引擎，返回值：

  • true：开通流引擎。

  • false：未开通流引擎。

true
Tags

array<object>

标签列表。

object

Key

string

标签的键。

test
Value

string

标签的值。

2.2.18
EnableCompute

boolean

是否开通实例的计算引擎，返回：

  • true：已开通。

  • false：未开通。

true
ResourceGroupId

string

资源组 ID。

rg-aekzledqeat****
EnableMessage

boolean

是否开通消息引擎，返回：

  • true：已开通。

  • false：未开通。

true
EnableVector

boolean

是否开通向量引擎，返回：

  • true：已开通。

  • false：未开通。

true
EnableLts

boolean

是否开通 LTS 引擎，返回：

  • true：已开通。

  • false：未开通。

true
EnableColumn

boolean

是否开通列存引擎，返回：

  • true：已开通。

  • false：未开通。

true
EnableRow

boolean

是否开通宽表 3.0 引擎，返回：

true：已开通。 false：未开通。

true
CreateErrorCode

string

示例

正常返回示例

JSON格式

{
  "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": ""
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 Instance.IsDeleted The instance is deleted. 操作失败，该实例已删除。
400 Instance.IsNotAvailable The 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. 操作失败，当前环境中该API无法使用。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetLindormInstanceEngineList - 获取Lindorm实例支持的引擎类型下一篇：RenewLindormInstance - 为Lindorm实例续费