GetLindormInstance_云原生多模数据库 Lindorm_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为300/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
lindorm:GetLindormInstance
Get
全部资源
*

请求参数

字段名称字段详情
InstanceIdstring

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

示例值:ld-bp1o3y0yme2i2****参考取值来源:
    RenewLindormInstance
    ModifyInstancePayType
    CreateLindormInstance
    GetLindormInstanceList

返回参数

字段名称字段详情
VpcIdstring

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

示例值:vpc-bp1n3i15v90el48nx****
VswitchIdstring

虚拟交换机 ID。

示例值:vsw-bp1vbjzmod9q3l9eo****
CreateTimestring

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

示例值:2021-07-26 17:10:26
PayTypestring

实例的付费类型,返回:展开详情

示例值:POSTPAY
NetworkTypestring

实例的网络类型。

示例值:vpc
ServiceTypestring

实例类型,取值:展开详情

示例值:lindorm
EnableKmsboolean

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

示例值:false
EnableStoreTDEboolean

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

示例值:false
DiskUsagestring

磁盘空间使用率。

示例值:0.0%
DiskCategorystring

存储类型,返回:展开详情

示例值:cloud_efficiency
RequestIdstring

请求 ID。

示例值:633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
ColdStorageinteger<int32>

容量型云存储容量。

示例值:0GB
ArchiveStorageinteger<int32>

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

示例值:0GB
ExpiredMillisecondsinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1629993600000
EngineTypeinteger<int32>

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

示例值:15
ExpireTimestring

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

示例值:2021-08-27 00:00:00
AutoRenewboolean

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

示例值:false
DeletionProtectionstring

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

示例值:false
InstanceStoragestring

实例的存储容量。

示例值:480
AliUidinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:164901546557****
InstanceIdstring

实例 ID。

示例值:ld-bp1o3y0yme2i2****
RegionIdstring

地域 ID。

示例值:cn-hangzhou
CreateMillisecondsinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1627290664000
InstanceAliasstring

实例名称。

示例值:test0726
DiskThresholdstring

磁盘空间的阈值。

示例值:80%
ZoneIdstring

可用区 ID。

示例值:cn-hangzhou-h
InstanceStatusstring

实例状态,返回:展开详情

示例值:ACTIVATION
EngineListarray<object>

引擎信息列表。

EnableComputeboolean

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

示例值:true
EnableSSLboolean

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

示例值:false
EnableMLCtrlboolean

是否开通 AI 控制节点展开详情

示例值:False
EnableCdcboolean

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

示例值:false
EnableStreamboolean

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

示例值:true
EnableLTSboolean

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

示例值:true
EnableShsboolean

是否开通计算引擎 History Server。

示例值:true
EnableBlobboolean

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

示例值:true
MaintainStartTimestring

可维护开始时间。

示例值:00:00Z
MaintainEndTimestring

可维护结束时间。

示例值:20:00Z
ResourceGroupIdstring

资源组 ID。

示例值:rg-aek2wvd6oia****
PrimaryZoneIdstring

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

示例值:cn-shanghai-e
StandbyZoneIdstring

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

示例值:cn-shanghai-f
ArbiterZoneIdstring

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

示例值:cn-shanghai-g
PrimaryVSwitchIdstring

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

示例值:vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchIdstring

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

示例值:vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchIdstring

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

示例值:vsw-uf6664pqjawb87k36****
MultiZoneCombinationstring

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

示例值:cn-shanghai-efg-aliyun
CoreDiskCategorystring

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

示例值:cloud_efficiency
CoreSpecstring

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

示例值:lindorm.g.xlarge
CoreNuminteger<int32>

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

示例值:4
CoreSingleStorageinteger<int32>

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

示例值:400
LogDiskCategorystring

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

示例值:cloud_ssd
LogSpecstring

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

示例值:lindorm.sn1.large
LogNuminteger<int32>

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

示例值:4
LogSingleStorageinteger<int32>

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

示例值:400GB
ArchVersionstring

部署架构,取值:展开详情

示例值:1.0
EnableLsqlVersionV3boolean

宽表引擎是否支持 LindormSQL-V3 能力,其兼容 MySQL 协议,展开详情

示例值:True
EnableLProxyboolean

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

示例值:False

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Instance.IsDeleted
The instance is deleted.诊断
400
Instance.IsNotValid
The instance is invalid.诊断
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.诊断
403
Lindorm.Errorcode.ServiceLinkedRoleNoPermission
No permission to create service linked role.诊断

变更历史

变更时间变更内容概要操作
2025-03-18
变更返回参数
2024-10-11
变更返回参数
2024-06-04
变更返回参数
2023-11-15
变更错误码400
2023-09-27
变更返回参数
2023-08-08
变更返回参数
2023-07-03
变更返回参数
2023-07-03
变更返回参数
2023-06-20
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例