调用GetLindormInstanceList获取Lindorm实例列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetLindormInstanceList

系统规定参数。取值:GetLindormInstanceList

RegionId String cn-hangzhou

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

QueryStr String test

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

PageNumber Integer 1

指定要查询的页码。

PageSize Integer 20

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

ServiceType String lindorm

实例类型,取值:

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

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

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

标签的键。

Tag.N.Value String 2.2.18

标签的值。

返回数据

名称 类型 示例值 描述
RequestId String 1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0

请求ID。

PageNumber Integer 1

实例所在页码。

PageSize Integer 20

实例所在页的行数。

Total Integer 1

查询到的实例总数。

InstanceList Array of LindormInstanceSummary
VpcId String vpc-bp1n3i15v90el48nx****

实例所属的专有网络ID。

EngineType String 15

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

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

实例的到期时间。

说明 实例的付费类型为包年包月,才会返回本参数。
CreateTime String 2021-09-16 14:13:13

实例的创建时间。

PayType String PREPAY

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

  • PREPAY:包年包月。
  • POSTPAY:按量付费。
AliUid Long 1000000000000000

用户的16位AliUid。

InstanceStorage String 960

实例的存储容量。

InstanceId String ld-bp17pwu1541ia****

实例ID。

NetworkType String vpc

实例的网络类型。

ServiceType String lindorm

实例类型,返回值:

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

地域ID。

CreateMilliseconds Long 1631772842000

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

InstanceAlias String test

实例名称。

ZoneId String cn-hangzhou-h

可用区ID。

InstanceStatus String ACTIVATION

实例状态,返回值:

  • 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:实例已过期,锁定中。
ExpiredMilliseconds Long 1650902400000

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

EnableStream Boolean true

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

  • true:开通流引擎。
  • false:未开通流引擎。
Tags Array of Tag
Key String test

标签的键。

Value String 2.2.18

标签的值。

示例

请求示例

http(s)://hitsdb.aliyuncs.com/?Action=GetLindormInstanceList
&RegionId=cn-hangzhou
&QueryStr=test
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetLindormInstanceListResponse>
    <RequestId>1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0</RequestId>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <Total>1</Total>
    <InstanceList>
        <ExpiredMilliseconds>1650902400000</ExpiredMilliseconds>
        <InstanceStorage>960</InstanceStorage>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <InstanceId>ld-bp17pwu1541i****</InstanceId>
        <CreateTime>2021-09-16 14:13:13</CreateTime>
        <PayType>PREPAY</PayType>
        <VpcId>vpc-bp1n3i15v90el48nx****</VpcId>
        <NetworkType>vpc</NetworkType>
        <ServiceType>lindorm</ServiceType>
        <InstanceAlias>test</InstanceAlias>
        <InstanceStatus>ACTIVATION</InstanceStatus>
        <EnableStream>true</EnableStream>
        <EngineType>15</EngineType>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2022-04-26 00:00:00</ExpireTime>
        <CreateMilliseconds>1631772842000</CreateMilliseconds>
        <Tags>
            <Value>2.2.18</Value>
            <Key>test</Key>
        </Tags>
        <AliUid>1000000000000000</AliUid>
    </InstanceList>
</GetLindormInstanceListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
  "PageSize" : 20,
  "PageNumber" : 1,
  "Total" : 1,
  "InstanceList" : [ {
    "ExpiredMilliseconds" : 1650902400000,
    "InstanceStorage" : 960,
    "ZoneId" : "cn-hangzhou-h",
    "InstanceId" : "ld-bp17pwu1541i****",
    "CreateTime" : "2021-09-16 14:13:13",
    "PayType" : "PREPAY",
    "VpcId" : "vpc-bp1n3i15v90el48nx****",
    "NetworkType" : "vpc",
    "ServiceType" : "lindorm",
    "InstanceAlias" : "test",
    "InstanceStatus" : "ACTIVATION",
    "EnableStream" : true,
    "EngineType" : 15,
    "RegionId" : "cn-hangzhou",
    "ExpireTime" : "2022-04-26 00:00:00",
    "CreateMilliseconds" : 1631772842000,
    "Tags" : [ {
      "Value" : "2.2.18",
      "Key" : "test"
    } ],
    "AliUid" : 1000000000000000
  } ]
}

错误码

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