GetLindormInstance - 获取Lindorm指定实例的详细信息

调用GetLindormInstance获取Lindorm指定实例的详细信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

实例ID,可调用GetLindormInstanceList接口获取。

ld-bp1o3y0yme2i2****

返回参数

名称类型描述示例值
object
VpcIdstring

实例所属的专有网络(VPC)的ID。

vpc-bp1n3i15v90el48nx****
VswitchIdstring

虚拟交换机ID。

vsw-bp1vbjzmod9q3l9eo****
CreateTimestring

实例创建时间,格式:yyyy-MM-dd HH:mm:ss

2021-07-26 17:10:26
PayTypestring

实例的付费类型,返回:

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

实例的网络类型。

vpc
ServiceTypestring

实例类型,返回:

  • lindorm:普通实例。
  • serverless_lindorm:serverless实例。
lindorm
EnableKmsboolean

是否开启密钥管理服务KMS,返回:

  • true:开启。
  • false:关闭。
false
DiskUsagestring

磁盘空间使用率。

0.0%
DiskCategorystring

存储类型,返回:

  • cloud_efficiency:标准云存储。
  • cloud_ssd:性能云存储。
  • capacity_cloud_storage:容量云存储。
  • local_ssd_pro:本地SSD盘。
  • local_hdd_pro:本地HDD盘。
cloud_efficiency
RequestIdstring

请求ID。

633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
ColdStorageinteger

冷存储容量。

0
ExpiredMillisecondsLong

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

1629993600000
EngineTypeinteger

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

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

实例的到期时间,格式:yyyy-MM-dd HH:mm:ss

说明付费类型为包年包月,才会返回本参数。
2021-08-27 00:00:00
AutoRenewboolean

是否开通自动续费,返回:

  • true:开启。
  • false:关闭。
说明实例的付费类型为包年包月会返回此参数。
false
DeletionProtectionstring

是否开启删除保护,返回:

  • true:开启。
  • false:关闭。
false
InstanceStoragestring

实例的存储容量。

480
AliUidLong

用户的16位AliUid。

1000000000000000
InstanceIdstring

实例ID。

ld-bp1o3y0yme2i2****
RegionIdstring

地域ID。

cn-hangzhou
CreateMillisecondsLong

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

1627290664000
InstanceAliasstring

实例名称。

test0726
DiskThresholdstring

磁盘空间的阈值。

80%
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
EngineListarray

引擎信息列表。

object
Versionstring

引擎类型的版本号。

2.2.3
CpuCountstring

引擎节点CPU数量。

4
CoreCountstring

引擎节点数量。

2
Enginestring

引擎类型,返回:

  • lindorm:宽表引擎。
  • tsdb:时序引擎。
  • solr:搜索引擎。
  • store:文件引擎。
  • bds:LTS引擎。
  • compute:计算引擎。
lindorm
MemorySizestring

引擎类型的节点内存大小。

8
IsLastVersionboolean

引擎类型是否最新版本,返回:

  • true:最新版本。
  • false:不是最新版本。
false
LatestVersionstring

引擎类型对应的最新的版本号。

2.2.19.2
EnableComputeboolean

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

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

是否开启SSL链路加密功能,返回:

  • true:开启。
  • false:关闭。
false
EnableCdcboolean

是否开通实例的数据订阅功能,返回:

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

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

  • true:开通流引擎。
  • false:未开通流引擎。
true
EnableShsboolean

是否开通计算引擎History Server。

true
MaintainStartTimestring

可维护开始时间。

00:00Z
MaintainEndTimestring

可维护结束时间。

20:00Z
ResourceGroupIdstring

资源组ID。

rg-aek2wvd6oia4b2a

示例

请求示例

http(s)://hitsdb.aliyuncs.com/?Action=GetLindormInstance
&InstanceId=ld-bp1o3y0yme2i2****
&<公共请求参数>

正常返回示例

JSON格式

{
    "ExpiredMilliseconds": 1629993600000,
    "DiskThreshold": "80%",
    "EngineList": [
        {
            "MemorySize": 8,
            "CpuCount": 4,
            "Version": "2.2.9.1",
            "Engine": "lindorm",
            "IsLastVersion": true,
            "CoreCount": 2
        },
        {
            "MemorySize": 16,
            "CpuCount": 4,
            "Version": "3.2.15",
            "Engine": "tsdb",
            "IsLastVersion": false,
            "CoreCount": 2
        },
        {
            "MemorySize": 16,
            "CpuCount": 4,
            "Version": "7.7.10",
            "Engine": "solr",
            "IsLastVersion": true,
            "CoreCount": 2
        },
        {
            "MemorySize": 8,
            "CpuCount": 4,
            "Version": "3.10.6",
            "Engine": "store",
            "IsLastVersion": true,
            "CoreCount": 2
        }
    ],
    "EnableBDS": false,
    "AutoRenew": false,
    "DiskUsage": "0.0%",
    "EnableFS": true,
    "EnableCompute": true,
    "InstanceAlias": "test0726",
    "InstanceStatus": "ACTIVATION",
    "NetworkType": "vpc",
    "ServiceType": "lindorm",
    "EngineType": 15,
    "CreateMilliseconds": 1627290664000,
    "EnableSSL": false,
    "InstanceStorage": 480,
    "RequestId": "633F1BE4-C8DA-5744-8FDF-A3075C3FE37F",
    "ZoneId": "cn-hangzhou-h",
    "InstanceId": "ld-bp1o3y0yme2i2****",
    "EnableKms": false,
    "CreateTime": "2021-07-26 17:10:26",
    "ColdStorage": 0,
    "DiskCategory": "cloud_efficiency",
    "PayType": "PREPAY",
    "DeletionProtection": false,
    "VswitchId": "vsw-bp1vbjzmod9q3l9eo****",
    "VpcId": "vpc-bp1n3i15v90el48nx****",
    "EnableCdc": false,
    "EnablePhoenix": false,
    "RegionId": "cn-hangzhou",
    "ExpireTime": "2021-08-27 00:00:00",
    "AliUid": "1000000000000000"
}

XML格式

<GetLindormInstanceResponse>
<ExpiredMilliseconds>1629993600000</ExpiredMilliseconds>
<DiskThreshold>80%</DiskThreshold>
<EngineList>
    <MemorySize>8</MemorySize>
    <CpuCount>4</CpuCount>
    <Version>2.2.9.1</Version>
    <Engine>lindorm</Engine>
    <IsLastVersion>true</IsLastVersion>
    <CoreCount>2</CoreCount>
</EngineList>
<EngineList>
    <MemorySize>16</MemorySize>
    <CpuCount>4</CpuCount>
    <Version>3.2.15</Version>
    <Engine>tsdb</Engine>
    <IsLastVersion>false</IsLastVersion>
    <CoreCount>2</CoreCount>
</EngineList>
<EngineList>
    <MemorySize>16</MemorySize>
    <CpuCount>4</CpuCount>
    <Version>7.7.10</Version>
    <Engine>solr</Engine>
    <IsLastVersion>true</IsLastVersion>
    <CoreCount>2</CoreCount>
</EngineList>
<EngineList>
    <MemorySize>8</MemorySize>
    <CpuCount>4</CpuCount>
    <Version>3.10.6</Version>
    <Engine>store</Engine>
    <IsLastVersion>true</IsLastVersion>
    <CoreCount>2</CoreCount>
</EngineList>
<EnableBDS>false</EnableBDS>
<AutoRenew>false</AutoRenew>
<DiskUsage>0.0%</DiskUsage>
<EnableFS>true</EnableFS>
<EnableCompute>true</EnableCompute>
<InstanceAlias>test0726</InstanceAlias>
<InstanceStatus>ACTIVATION</InstanceStatus>
<NetworkType>vpc</NetworkType>
<ServiceType>lindorm</ServiceType>
<EngineType>15</EngineType>
<CreateMilliseconds>1627290664000</CreateMilliseconds>
<EnableSSL>false</EnableSSL>
<InstanceStorage>480</InstanceStorage>
<RequestId>633F1BE4-C8DA-5744-8FDF-A3075C3FE37F</RequestId>
<ZoneId>cn-hangzhou-h</ZoneId>
<InstanceId>ld-bp1o3y0yme2i2****</InstanceId>
<EnableKms>false</EnableKms>
<CreateTime>2021-07-26 17:10:26</CreateTime>
<ColdStorage>0</ColdStorage>
<DiskCategory>cloud_efficiency</DiskCategory>
<PayType>PREPAY</PayType>
<DeletionProtection>false</DeletionProtection>
<VswitchId>vsw-bp1vbjzmod9q3l9eo****</VswitchId>
<VpcId>vpc-bp1n3i15v90el48nx****</VpcId>
<EnableCdc>false</EnableCdc>
<EnablePhoenix>false</EnablePhoenix>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2021-08-27 00:00:00</ExpireTime>
<AliUid>1000000000000000</AliUid>
</GetLindormInstanceResponse>

错误码

Http code错误码错误信息描述
400Lindorm.Errorcode.ParameterInvaildThe parameter is invalid.参数无效
400Instance.IsDeletedThe instance is deleted.实例已删除。
400Instance.IsNotValidThe instance is invalid.操作失败,实例无效。
403Lindorm.Errorcode.OperationDeniedYou are not authorized to operate on the specified resource.您没有指定资源的操作权限,请先对资源进行授权操作。
403API.ForbiddenThe API operation is forbidden in this environment.操作失败,当前环境中该API无法使用。
403Lindorm.Errorcode.ServiceLinkedRoleNoPermissionNo permission to create service linked role.操作失败,请先申请创建服务关联角色的权限。

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

变更历史

变更时间变更内容概要操作
2021-10-14OpenAPI 错误码发生变更、 OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2021-10-14OpenAPI 错误码发生变更、 OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
阿里云首页 云原生多模数据库 Lindorm 相关技术圈