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

获取Lindorm实例的详细信息,包括实例类型、付费类型、所属专有网络等。

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

lindorm:GetLindormInstance

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

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

ld-bp1o3y0yme2i2****

返回参数

名称

类型

描述

示例值

object

VpcId

string

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

vpc-bp1n3i15v90el48nx****

VswitchId

string

虚拟交换机 ID。

vsw-bp1vbjzmod9q3l9eo****

CreateTime

string

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

2021-07-26 17:10:26

PayType

string

实例的付费类型,返回:

  • PREPAY:包年包月。

  • POSTPAY:按量付费。

POSTPAY

NetworkType

string

实例的网络类型。

vpc

ServiceType

string

实例类型,取值:

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

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

  • serverless_lindorm:表示 Lindorm Serverless 实例。

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

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

lindorm

EnableKms

boolean

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

  • true:开启。

  • false:关闭。

false

EnableStoreTDE

boolean

是否开启存储加密服务,返回:

  • true:开启。

  • false:关闭。

false

DiskUsage

string

磁盘空间使用率。

0.0%

DiskCategory

string

存储类型,返回:

  • cloud_efficiency:标准型云存储。

  • cloud_ssd:性能型云存储。

  • cloud_essd:性能增强型云存储。

  • cloud_essd_pl0:性能型云存储 pl0。

  • capacity_cloud_storage:容量型云存储。

  • local_ssd_pro:本地 SSD 盘。

  • local_hdd_pro:本地 HDD 盘。

cloud_efficiency

RequestId

string

请求 ID。

633F1BE4-C8DA-5744-8FDF-A3075C3FE37F

ColdStorage

integer

容量型云存储容量。

0GB

ArchiveStorage

integer

归档存储类型的计费存储量,单位 GB。

0GB

ExpiredMilliseconds

integer

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

1629993600000

EngineType

integer

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

  • 1: 搜索引擎

  • 2: 时序引擎

  • 4: 宽表引擎

  • 8: 文件引擎

说明

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

15

ExpireTime

string

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

说明

付费类型为包年包月,才会返回本参数。

2021-08-27 00:00:00

AutoRenew

boolean

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

  • true:开启。

  • false:关闭。

说明

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

false

DeletionProtection

string

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

  • true:开启。

  • false:关闭。

false

InstanceStorage

string

实例的存储容量。

480

AliUid

integer

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

164901546557****

InstanceId

string

实例 ID。

ld-bp1o3y0yme2i2****

RegionId

string

地域 ID。

cn-hangzhou

CreateMilliseconds

integer

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

1627290664000

InstanceAlias

string

实例名称。

test0726

DiskThreshold

string

磁盘空间的阈值。

80%

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

EngineList

array<object>

引擎信息列表。

object

引擎信息列表。

Version

string

引擎类型的版本号。

2.2.3

CpuCount

string

引擎节点 CPU 数量。

4

CoreCount

string

引擎节点数量。

2

Engine

string

引擎类型,返回:

  • lindorm:宽表引擎。

  • tsdb:时序引擎。

  • solr:搜索引擎。

  • store:文件引擎。

  • bds:LTS 引擎。

  • compute:计算引擎。

lindorm

Specification

string

引擎节点规格

lindorm.g.2xlarge

MemorySize

string

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

8GB

IsLastVersion

boolean

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

  • true:最新版本。

  • false:不是最新版本。

false

LatestVersion

string

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

2.2.19.2

PrimaryCoreCount

string

StandbyCoreCount

string

ArbiterCoreCount

string

EnableCompute

boolean

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

  • true:已开通。

  • false:未开通。

true

EnableSSL

boolean

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

  • true:开启。

  • false:关闭。

false

EnableMLCtrl

boolean

是否开通 AI 控制节点

  • True: 表示开通

  • False: 表示未开通

False

EnableCdc

boolean

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

  • true:已开通。

  • false:未开通。

false

EnableStream

boolean

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

  • true:开通流引擎。

  • false:未开通流引擎。

true

EnableLTS

boolean

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

  • true:开通 LTS 引擎。

  • false:未开通 LTS 引擎。

true

EnableShs

boolean

是否开通计算引擎 History Server。

true

EnableBlob

boolean

实例是否开通 LBlob,返回值:

true:开通 LBlob。 false:未开通 LBlob。

true

MaintainStartTime

string

可维护开始时间。

00:00Z

MaintainEndTime

string

可维护结束时间。

20:00Z

ResourceGroupId

string

资源组 ID。

rg-aek2wvd6oia****

PrimaryZoneId

string

多可用区实例,主可用区的可用区 ID。

cn-shanghai-e

StandbyZoneId

string

多可用区实例,备可用区的可用区 ID。

cn-shanghai-f

ArbiterZoneId

string

多可用区实例,协调可用区的可用区 ID。

cn-shanghai-g

PrimaryVSwitchId

string

多可用区实例,主可用区的虚拟交换机 ID,必须在 PrimaryZoneId 对应的可用区下。

vsw-uf6fdqa7c0pipnqzq****

StandbyVSwitchId

string

多可用区实例,备可用区的虚拟交换机 ID,必须在 StandbyZoneId 对应的可用区下。

vsw-2zec0kcn08cgdtr6****

ArbiterVSwitchId

string

多可用区实例,协调可用区虚拟交换机 ID,交换机需位于 ArbiterZoneId 对应的可用区下。

vsw-uf6664pqjawb87k36****

MultiZoneCombination

string

多可用区组合。可用区组合支持情况可前往售卖页查看。

  • ap-southeast-5abc-aliyun:印度尼西亚(雅加达)A+B+C。

  • cn-hangzhou-ehi-aliyun:华东 1(杭州)E+H+I。

  • cn-beijing-acd-aliyun:华北 2(北京)A+C+D。

  • ap-southeast-1-abc-aliyun:新加坡 A+B+C。

  • cn-zhangjiakou-abc-aliyun:华北 3(张家口)A+B+C。

  • cn-shanghai-efg-aliyun:华东 2(上海)E+F+G。

  • cn-shanghai-abd-aliyun:华东 2(上海)A+B+D。

  • cn-hangzhou-bef-aliyun:华东 1(杭州)B+E+F。

  • cn-hangzhou-bce-aliyun:华东 1(杭州)B+C+E。

  • cn-beijing-fgh-aliyun:华北 2(北京)F+G+H。

  • cn-shenzhen-abc-aliyun:华南 1(深圳)A+B+C。

cn-shanghai-efg-aliyun

CoreDiskCategory

string

多可用区实例,core 节点磁盘类型,返回:

  • cloud_efficiency:标准型云存储。

  • cloud_ssd:性能型云存储。

  • cloud_essd:性能增强型云存储。

  • cloud_essd_pl0:性能型云存储 pl0。

cloud_efficiency

CoreSpec

string

多可用区实例,core 节点规格。

lindorm.g.xlarge

CoreNum

integer

多可用区实例,core 节点数量。

4

CoreSingleStorage

integer

多可用区实例,core 单节点磁盘容量。

400

LogDiskCategory

string

多可用区实例,log 节点磁盘类型,返回:

  • cloud_efficiency:标准云存储。

  • cloud_ssd:性能云存储。

cloud_ssd

LogSpec

string

多可用区实例,log 节点规格。

lindorm.sn1.large

LogNum

integer

多可用区实例,log 节点数量。

4

LogSingleStorage

integer

多可用区实例,log 单节点磁盘容量。

400GB

ArchVersion

string

部署架构,取值:

  • 1.0:单可用区。

  • 2.0:多可用区。

1.0

EnableLsqlVersionV3

boolean

宽表引擎是否支持 LindormSQL-V3 能力,其兼容 MySQL 协议, 2023-10-24 号之后新购的实例默认支持;存量实例需要联系值班同学评估后再打开。

  • True 表示支持

  • False 表示不支持

True

EnableLProxy

boolean

宽表引擎是否支持 Thrift、CQL 协议。如不支持的话,可以通过 SwitchLProxyService 接口进行开通与关闭。

True 表示支持

False 表示不支持

False

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-bp1n3i15v90el48nx****",
  "VswitchId": "vsw-bp1vbjzmod9q3l9eo****",
  "CreateTime": "2021-07-26 17:10:26",
  "PayType": "POSTPAY",
  "NetworkType": "vpc",
  "ServiceType": "lindorm",
  "EnableKms": false,
  "EnableStoreTDE": false,
  "DiskUsage": "0.0%",
  "DiskCategory": "cloud_efficiency",
  "RequestId": "633F1BE4-C8DA-5744-8FDF-A3075C3FE37F",
  "ColdStorage": 0,
  "ArchiveStorage": 0,
  "ExpiredMilliseconds": 1629993600000,
  "EngineType": 15,
  "ExpireTime": "2021-08-27 00:00:00",
  "AutoRenew": false,
  "DeletionProtection": "false",
  "InstanceStorage": "480",
  "AliUid": 0,
  "InstanceId": "ld-bp1o3y0yme2i2****",
  "RegionId": "cn-hangzhou",
  "CreateMilliseconds": 1627290664000,
  "InstanceAlias": "test0726",
  "DiskThreshold": "80%",
  "ZoneId": "cn-hangzhou-h",
  "InstanceStatus": "ACTIVATION",
  "EngineList": [
    {
      "Version": "2.2.3",
      "CpuCount": "4",
      "CoreCount": "2",
      "Engine": "lindorm",
      "Specification": "lindorm.g.2xlarge",
      "MemorySize": "8GB",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2",
      "PrimaryCoreCount": "",
      "StandbyCoreCount": "",
      "ArbiterCoreCount": ""
    }
  ],
  "EnableCompute": true,
  "EnableSSL": false,
  "EnableMLCtrl": true,
  "EnableCdc": false,
  "EnableStream": true,
  "EnableLTS": true,
  "EnableShs": true,
  "EnableBlob": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "ResourceGroupId": "rg-aek2wvd6oia****",
  "PrimaryZoneId": "cn-shanghai-e",
  "StandbyZoneId": "cn-shanghai-f",
  "ArbiterZoneId": "cn-shanghai-g",
  "PrimaryVSwitchId": "vsw-uf6fdqa7c0pipnqzq****",
  "StandbyVSwitchId": "vsw-2zec0kcn08cgdtr6****",
  "ArbiterVSwitchId": "vsw-uf6664pqjawb87k36****",
  "MultiZoneCombination": "cn-shanghai-efg-aliyun",
  "CoreDiskCategory": "cloud_efficiency",
  "CoreSpec": "lindorm.g.xlarge",
  "CoreNum": 4,
  "CoreSingleStorage": 400,
  "LogDiskCategory": "cloud_ssd",
  "LogSpec": "lindorm.sn1.large",
  "LogNum": 4,
  "LogSingleStorage": 0,
  "ArchVersion": "1.0",
  "EnableLsqlVersionV3": true,
  "EnableLProxy": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 Instance.IsDeleted The instance is deleted.
400 Instance.IsNotValid The instance is invalid. 操作失败,实例无效。
400 LindormErrorCode.%s %s. 通用错误码返回,具体请参考错误信息提示
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无法使用。
403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. 操作失败,请先申请创建服务关联角色的权限。

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

变更历史

更多信息,参考变更详情