GetLindormV2InstanceDetails - 查询Lindorm V2实例详情

查询新架构实例详情

接口说明

Lindorm 集群的底层存储版本>= 4.1.9 以后,存储使用详情参考 LStorageUsageList 放回的列表值。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

lindorm:GetLindormV2InstanceDetails

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

ld-bp1mq0tdzbx1m****

返回参数

名称

类型

描述

示例值

object

VpcId

string

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

vpc-bp1xxxxxxxxxxxxxxxxxx

VswitchId

string

虚拟交换机 ID。

vsw-bp1xxxxxxxxxxxxxxxxxx

PayType

string

实例的付费类型,返回:

  • PREPAY:包年包月。

  • POSTPAY:按量付费。

POSTPAY

NetworkType

string

实例的网络类型。

VPC

DiskUsage

string

磁盘空间使用率。

0.0%

DiskCategory

string

存储类型,返回:

  • StandardStorage:标准型云存储。

  • PerformanceStorage:性能型云存储。

PerformanceStorage

RequestId

string

请求 ID。

1556DCB0-043A-4444-8BD9-CF4A68E7EE64

ColdStorage

integer

容量型云存储容量。

800

ExpiredMilliseconds

integer

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

1629993600000

AutoRenew

boolean

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

  • true:开启。

  • false:关闭。

说明

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

true

DeletionProtection

string

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

  • true:开启。

  • false:关闭。

false

AliUid

integer

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

164901546557****

InstanceId

string

实例 ID。

ld-bp1mq0tdzbx1m****

InstanceType

string

形态选择,取值:

  • basic:生产型

basic

RegionId

string

地域 ID。

cn-hangzhou

CreateMilliseconds

integer

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

1627290664000

InstanceAlias

string

实例名称。

lindorm-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

PrimaryZoneId

string

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

cn-shanghai-e

PrimaryVSwitchId

string

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

vsw-uf6fdqa7c0pipnqzq****

StandbyZoneId

string

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

cn-shanghai-f

StandbyVSwitchId

string

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

vsw-2zec0kcn08cgdtr6****

ArbiterZoneId

string

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

cn-shanghai-g

ArbiterVSwitchId

string

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

vsw-uf6664pqjawb87k36****

EngineList

array<object>

引擎信息列表。

object

引擎信息列表。

Version

string

引擎类型的版本号。

2.2.3

Engine

string

引擎类型,返回:

  • TABLE:宽表引擎。

  • TSDB:时序引擎。

  • LSEARCH:搜索引擎。

  • LTS:LTS 引擎。

  • LVECTOR:向量引擎。

  • LCOLUMN:列存引擎。

TABLE

IsLastVersion

boolean

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

  • true:最新版本。

  • false:不是最新版本。

false

LatestVersion

string

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

2.2.19.2

ConnectAddressList

array<object>

引擎链接地址列表

object

引擎链接地址列表

Address

string

链接地址

ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060

Type

string

链接地址类型

  • INTRANET: VPC 私网地址

  • INTERNET:公网地址

INTRANET

Port

string

数据库连接地址的端口号。

33060

NodeGroup

array<object>

引擎节点组列表

object

引擎节点组列表

NodeSpec

string

节点规格

选择性能型云存储或标准型云存储,本参数取值为:

  • lindorm.c.2xlarge:表示 8 核 16GB。

  • lindorm.g.2xlarge:表示 8 核 32GB。

  • lindorm.c.4xlarge:表示 16 核 32GB。

  • lindorm.g.4xlarge:表示 16 核 64GB。

  • lindorm.c.8xlarge:表示 32 核 64GB。

  • lindorm.g.8xlarge:表示 32 核 128GB。

  • lindorm.r.2xlarge:表示 8 核 64GB。

  • lindorm.r.4xlarge:表示 16 核 128GB。

  • lindorm.r.8xlarge:表示 32 核 256GB。

选择本地 SSD 类型时,本参数取值为,

  • lindorm.i4.xlarge:表示 4 核 32GB(I4)。

  • lindorm.i4.2xlarge:表示 8 核 64GB(I4)。

  • lindorm.i4.4xlarge:表示 16 核 128GB(I4)。

  • lindorm.i4.8xlarge:表示 32 核 256GB(I4)。

  • lindorm.i3.xlarge:表示 4 核 32GB(I3)。

  • lindorm.i3.2xlarge:表示 8 核 64GB(I3)。

  • lindorm.i3.4xlarge:表示 16 核 128GB(I3)。

  • lindorm.i3.8xlarge:表示 32 核 256GB(I3)。

  • lindorm.i2.xlarge:表示 4 核 32GB(I2)。

  • lindorm.i2.2xlarge:表示 8 核 64GB(I2)。

  • lindorm.i2.4xlarge:表示 16 核 128GB(I2)。

  • lindorm.i2.8xlarge:表示 32 核 256GB(I2)。

选择大数据型时,本参数取值为:

  • lindorm.sd3c.3xlarge:表示 14 核 56GB(D3C PRO)。

  • lindorm.sd3c.7xlarge:表示 28 核 112GB(D3C PRO)。

  • lindorm.sd3c.14xlarge:表示 56 核 224GB(D3C PRO)。

  • lindorm.d2c.6xlarge:表示 24 核 88GB(D2C)。

  • lindorm.d2c.12xlarge:表示 48 核 176GB(D2C)。

  • lindorm.d2c.24xlarge:表示 96 核 352GB(D2C)。

  • lindorm.d2s.5xlarge:表示 20 核 88GB(D2S)。

  • lindorm.d2s.10xlarge:表示 40 核 176GB(D2S)。

  • lindorm.d1.2xlarge:表示 8 核 32GB(D1NE)。

  • lindorm.d1.4xlarge:表示 16 核 64GB(D1NE)。

  • lindorm.d1.6xlarge:表示 24 核 96GB(D1NE)。

lindorm.g.2xlarge

EnableAttachLocalDisk

boolean

节点上是否挂载本地云盘

false

LocalDiskCategory

string

本地云盘类型

  • cloud_essd: 性能型云盘

  • cloud_efficiency: 标准型云盘

cloud_essd

LocalDiskCapacity

integer

本地云盘空间大小,单位 GB

100

CpuCoreCount

integer

节点 vCPU 核数目。

32

MemorySizeGiB

integer

节点内存大小。

64

Quantity

integer

节点数量

10

Category

string

废弃

caculated

ResourceGroupName

string

节点组名称,必填,与创建时保持一致

job_debug

SpecId

string

与交付组 ID 唯一对应的 ID。

ecs.c6.large

Status

string

节点状态

ACTIVATION

ResourceGroupId

string

资源组 ID。

rg-aek2i6weeb4nfii

ServiceType

string

实例类型,取值:

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

  • lindorm_v2_multizone:表示 Lindorm V2 多可用区基础版实例。

  • lindorm_v2_multizone_ha:表示 Lindorm V2 多可用区 g 高可用版实例。

lindorm_v2

WhiteIpList

array<object>

实例访问白名单

object

实例访问白名单

GroupName

string

分组名称,只允许包含字母、数字、下划线。

swhy

IpList

string

白名单 IP 地址。

['10.2.0.0/18', '10.0.0.0/24', '119.23.188.139/32']

StorageUsage

object

实例存储水位

CapacityByDiskCategory

array<object>

实例存储水位

object

实例存储水位

Capacity

EngineUsage

object

各引擎存储使用大小

16

ZoneEngineInfoMap

object

引擎可用区部署详情

ZoneEngineInfoMap

InitialRootPassword

string

初始化默认密码

*****

DiskThreshold

string

磁盘空间的阈值。

80%

EnableCompute

boolean

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

  • true:已开通。

  • false:未开通。

true

MaintainStartTime

string

可维护开始时间。

00:00Z

MaintainEndTime

string

可维护结束时间。

20:00Z

CloudStorageSize

integer

云存储空间,单位 GB

480

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-bp1xxxxxxxxxxxxxxxxxx",
  "VswitchId": "vsw-bp1xxxxxxxxxxxxxxxxxx",
  "PayType": "POSTPAY",
  "NetworkType": "VPC",
  "DiskUsage": "0.0%",
  "DiskCategory": "PerformanceStorage",
  "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  "ColdStorage": 800,
  "ExpiredMilliseconds": 1629993600000,
  "AutoRenew": true,
  "DeletionProtection": "false",
  "AliUid": 0,
  "InstanceId": "ld-bp1mq0tdzbx1m****",
  "InstanceType": "basic",
  "RegionId": "cn-hangzhou",
  "CreateMilliseconds": 1627290664000,
  "InstanceAlias": "lindorm-test",
  "ZoneId": "cn-hangzhou-h",
  "InstanceStatus": "ACTIVATION",
  "PrimaryZoneId": "cn-shanghai-e",
  "PrimaryVSwitchId": "vsw-uf6fdqa7c0pipnqzq****",
  "StandbyZoneId": "cn-shanghai-f",
  "StandbyVSwitchId": "vsw-2zec0kcn08cgdtr6****",
  "ArbiterZoneId": "cn-shanghai-g",
  "ArbiterVSwitchId": "vsw-uf6664pqjawb87k36****",
  "EngineList": [
    {
      "Version": "2.2.3",
      "Engine": "TABLE",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2",
      "ConnectAddressList": [
        {
          "Address": "ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060",
          "Type": "INTRANET",
          "Port": "33060"
        }
      ],
      "NodeGroup": [
        {
          "NodeSpec": "lindorm.g.2xlarge",
          "EnableAttachLocalDisk": false,
          "LocalDiskCategory": "cloud_essd",
          "LocalDiskCapacity": 100,
          "CpuCoreCount": 32,
          "MemorySizeGiB": 64,
          "Quantity": 10,
          "Category": "caculated",
          "ResourceGroupName": "job_debug",
          "SpecId": "ecs.c6.large",
          "Status": "ACTIVATION"
        }
      ]
    }
  ],
  "ResourceGroupId": "rg-aek2i6weeb4nfii",
  "ServiceType": "lindorm_v2",
  "WhiteIpList": [
    {
      "GroupName": "swhy",
      "IpList": "['10.2.0.0/18', '10.0.0.0/24', '119.23.188.139/32']"
    }
  ],
  "StorageUsage": {
    "CapacityByDiskCategory": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "EngineUsage": 16
  },
  "ZoneEngineInfoMap": {
    "test": "test",
    "test2": 1
  },
  "InitialRootPassword": "*****",
  "DiskThreshold": "80%",
  "EnableCompute": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "CloudStorageSize": 480
}

错误码

HTTP status code

错误码

错误信息

描述

400 Lindorm.Errorcode.ParameterInvaild The parameter is invalid.
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. 操作失败,请先申请创建服务关联角色的权限。

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

变更历史

更多信息,参考变更详情