文档

GetLindormInstanceList - 获取Lindorm实例列表

更新时间:

获取Lindorm实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
lindorm:GetLindormInstanceListRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
QueryStrstring

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

test
PageNumberinteger

指定要查询的页码。

1
PageSizeinteger

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

20
ServiceTypestring

实例类型,取值:

  • lindorm:表示 Lindorm 单可用区实例。
  • lindorm_multizone:表示 Lindorm 多可用区实例。
  • serverless_lindorm:表示 Lindorm Serverless 实例。
  • lindorm_standalone:表示 Lindorm 单节点实例。
  • lts:表示 Lindorm 数据通道服务类型。
lindorm
SupportEngineinteger

查询的实例支持的数据引擎类型,取值:

  • 1:支持搜索引擎。
  • 2:支持时序引擎。
  • 4:支持宽表引擎。
  • 8:支持文件引擎。
说明 例如:SupportEngine 取值为 15,15=8+4+2+1,表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。SupportEngine 取值为 6,6=4+2,表示该实例支持时序引擎和宽表引擎。
15
Tagobject []

标签列表。

Keystring

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

说明 可以传入多个标签的键。例如:第一对中的 Key 表示传入第一个标签的键。第二对中的 Key 表示传入第二个标签的键。
test
Valuestring

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

说明 可以传入多个标签的值。例如:第一对中的 Value 表示传入第一个标签的值。第二对中的 Value 表示传入第二个标签的值。
2.2.18
ResourceGroupIdstring

资源组 ID。

rg-aek3b63arvg27vi

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

实例所在页码。

1
PageSizeinteger

实例所在页的行数。

20
Totalinteger

查询到的实例总数。

1
InstanceListobject []

实例列表。

VpcIdstring

实例所属的专有网络 ID。

vpc-bp1n3i15v90el48nx****
EngineTypestring

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

  • 1:支持搜索引擎。
  • 2:支持时序引擎。
  • 4:支持宽表引擎。
  • 8:支持文件引擎。
说明 例如:EngineType 值为 15,15=8+4+2+1,表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType 值为 6,6=4+2,表示该实例支持时序引擎和宽表引擎。
15
ExpireTimestring

实例的到期时间。

说明 实例的付费类型为包年包月,才会返回本参数。
2022-04-26 00:00:00
CreateTimestring

实例的创建时间。

2021-09-16 14:13:13
PayTypestring

实例的付费类型,返回值:

  • PREPAY:包年包月。
  • POSTPAY:按量付费。
PREPAY
AliUidlong

阿里云账号(主账号)的 16 位 AliUid。

164901546557****
InstanceStoragestring

实例的存储容量。

960
InstanceIdstring

实例 ID。

ld-bp17pwu1541ia****
NetworkTypestring

实例的网络类型。

vpc
ServiceTypestring

实例类型,返回值:

  • lindorm:表示 Lindorm 实例。
  • serverless_lindorm:表示 LindormServerless 实例。
  • lindorm_standalone:表示 Lindorm 单节点实例。
  • lts:表示 Lindorm 数据通道服务类型。
lindorm
RegionIdstring

地域 ID。

cn-hangzhou
CreateMillisecondslong

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

1631772842000
InstanceAliasstring

实例名称。

test
ZoneIdstring

可用区 ID。

cn-hangzhou-h
InstanceStatusstring

实例状态,返回值:

  • 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
ExpiredMillisecondslong

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

1650902400000
EnableStreamboolean

实例是否开通流引擎,返回值:

  • true:开通流引擎。
  • false:未开通流引擎。
true
Tagsobject []

标签列表。

Keystring

标签的键。

test
Valuestring

标签的值。

2.2.18
EnableComputeboolean

是否开通实例的计算引擎,返回:

  • true:已开通。
  • false:未开通。
true
ResourceGroupIdstring

资源组 ID。

rg-aekzledqeat****

示例

正常返回示例

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
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Instance.IsDeletedThe instance is deleted.操作失败,该实例已删除。
400Instance.IsNotAvailableThe instance is unavailable.操作失败,实例不可用。
403Lindorm.Errorcode.OperationDeniedYou are not authorized to operate on the specified resource.-
403API.ForbiddenThe API operation is forbidden in this environment.操作失败,当前环境中该API无法使用。

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

变更历史

变更时间变更内容概要操作
2024-03-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2024-02-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-11-15OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
  • 本页导读 (1)