首页 云原生多模数据库 Lindorm API参考指南 API目录 实例 UpgradeLindormInstance - 变配Lindorm实例

UpgradeLindormInstance - 变配Lindorm实例

您可以为Lindorm实例开通冷存储,对Lindorm实例进行变配和扩容。

接口说明

Lindorm实例的数据引擎和存储规格,请参见如何选择数据引擎如何选择存储规格

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
lindorm:UpgradeLindormInstanceWrite
  • Lindorm
    acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

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

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

cn-shanghai
ZoneIdstring

可用区ID,可调用GetLindormInstance接口获取。

cn-shanghai-f
InstanceIdstring

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

ld-bp1o3y0yme2i2****
UpgradeTypestring

实例需要变配的类型,支持的变配类型请参见请求参数补充中的UpgradeType参数说明。

upgrade-cold-storage
ClusterStorageinteger

变配后实例的存储容量,单位为GB,取值:480~1017600

480
ColdStorageinteger

变配后实例的冷存储容量,单位为GB,取值:800~1000000

800
SolrSpecstring

变配后实例的搜索引擎节点规格,取值:

  • lindorm.g.xlarge:表示4核16GB(独享规格)。
  • lindorm.g.2xlarge:表示8核32GB(独享规格)。
  • lindorm.g.4xlarge:表示16核64GB(独享规格)。
  • lindorm.g.8xlarge:表示32核128GB(独享规格)。
lindorm.g.xlarge
SolrNuminteger

变配后实例的搜索引擎节点数量,取值:0~60

2
LindormSpecstring

变配后实例的宽表引擎节点规格,取值:

  • lindorm.c.xlarge:表示4核8GB(独享规格)。
  • lindorm.c.2xlarge:表示8核16GB(独享规格)。
  • lindorm.c.4xlarge:表示16核32GB(独享规格)。
  • lindorm.c.8xlarge:表示32核64GB(独享规格)。
lindorm.c.xlarge
LindormNuminteger

变配后实例的宽表引擎节点数量,取值:0~90

说明本参数需要和LindormSpec参数同时传入。
2
TsdbSpecstring

变配后实例的时序引擎节点规格,取值:

  • lindorm.g.xlarge:表示4核16GB(独享规格)。
  • lindorm.g.2xlarge:表示8核32GB(独享规格)。
  • lindorm.g.4xlarge:表示16核64GB(独享规格)。
  • lindorm.g.8xlarge:表示32核128GB(独享规格)。
lindorm.g.xlarge
TsdbNuminteger

变配后实例的时序引擎节点数量,取值:0~24

2
FilestoreSpecstring

变配后实例的文件引擎节点规格,取值:

  • lindorm.g.xlarge:表示4核16GB(独享规格)。
  • lindorm.g.2xlarge:表示8核32GB(独享规格)。
  • lindorm.g.4xlarge:表示16核64GB(独享规格)。
  • lindorm.g.8xlarge:表示32核128GB(独享规格)。
lindorm.g.xlarge
FilestoreNuminteger

变配后实例的文件引擎节点数量,取值:0~60

2
StreamSpecstring

变配后实例的流引擎节点规格,取值:

  • lindorm.c.2xlarge:表示8核16GB(独享规格)。
  • lindorm.c.4xlarge:表示16核32GB(独享规格)。
  • lindorm.c.8xlarge:表示32核64GB(独享规格)。
lindorm.g.xlarge
StreamNuminteger

变配后实例的流引擎节点数量,取值:0~90

2
LtsCoreSpecstring

变配后实例的LTS节点规格,取值:

  • lindorm.g.xlarge:表示4核16GB(独享规格)。
  • lindorm.g.2xlarge:表示8核32GB(独享规格)。
lindorm.g.xlarge
LtsCoreNuminteger

变配后实例的LTS节点数量,取值:0~50

2
PhoenixCoreSpecstring

变配后实例的Phoenix节点规格,取值:

  • lindorm.c.large:表示2核4GB(独享规格)。
  • lindorm.c.xlarge:表示4核8GB(独享规格)。
  • lindorm.g.xlarge :表示4核16GB(独享规格)。
  • lindorm.c.2xlarge:表示8核16GB(独享规格)。
  • lindorm.g.2xlarge:表示8核32GB(独享规格)。
lindorm.c.xlarge
PhoenixCoreNuminteger

变配后实例的Phoenix节点数量。

2
CoreSingleStorageinteger

多可用区实例,变配后实例的core单节点容量。取值范围400~64000,单位GB。如果目标实例是多可用区实例,选填该参数。

400GB
LogSpecstring

多可用区实例,变配后实例的log节点规格。取值如下:

  • lindorm.sn1.large:表示4核8GB(独享规格)。
  • lindorm.sn1.2xlarge:表示8核16GB(独享规格)。

如果目标实例是多可用区实例,选填该参数。

lindorm.sn1.large
LogNuminteger

多可用区实例,变配后实例的log节点数量。取值范围4~400。如果目标实例是多可用区实例,选填该参数。

4
LogSingleStorageinteger

多可用区实例,变配后实例的log单节点磁盘容量。取值范围400-64000,单位GB。如果目标实例是多可用区实例,选填该参数。

400GB

UpgradeType参数说明

UpgradeLindormInstance接口中传入UpgradeType参数指定实例的变配类型后,您还需要在对应必选参数中传入配置规格,具体信息请参见下表。

UpgradeType参数类型必选参数描述
upgrade-cold-storageStringColdStorage开通或扩容冷存储。
upgrade-disk-sizeStringClusterStorage扩容云盘。
open-search-engineString本盘类型实例:SolrNum
非本盘类型:SolrNum、SolrSpec、ClusterStorage
开通搜索引擎。
upgrade-search-engineStringSolrSpec升级搜索引擎规格。 说明 本盘类型不支持此参数变配。
upgrade-search-core-numStringSolrNum和ClusterStorage变配搜索引擎节点数。
open-lindorm-engineString本盘类型:LindormNum
非本盘类型:LindormNum、LindormSpec、ClusterStorage
开通宽表引擎。
upgrade-lindorm-engineStringLindormSpec升级宽表引擎规格。 说明 本盘类型不支持此参数变配。
upgrade-lindorm-core-numStringLindormNum和ClusterStorage变配宽表引擎节点数。
open-tsdb-engineStringTsdbSpec、TsdbNum、ClusterStorage开通时序引擎。
upgrade-tsdb-engineStringTsdbSpec升级时序引擎规格。 说明 本盘类型不支持此参数变配。
upgrade-tsdb-core-numStringTsdbNum和ClusterStorage变配时序引擎节点数。
open-stream-engineStringStreamSpec、StreamNum、ClusterStorage开通流引擎。
upgrade-stream-engineStringStreamSpec升级流引擎规格。 说明 本盘类型不支持此参数变配。
upgrade-stream-core-numStringStreamNum和ClusterStorage变配流引擎节点数。
upgrade-file-engineStringFilestoreSpec升级文件引擎规格。 说明 本盘类型不支持此参数变配。
upgrade-file-core-numStringFilestoreNum变配文件引擎节点数。
open-bds-transferString本盘类型:BdsCoreNum、BdsCoreSpec和SolrNum
非本盘类型:BdsCoreNum、BdsCoreSpec、SolrNum和SolrSpec
开通BDS(LTS)引擎和搜索引擎。
upgrade-bds-transferStringBdsCoreSpec变更BDS(LTS)引擎规格。
upgrade-bds-core-numStringBdsCoreNum变配BDS(LTS)引擎节点数。
open-bds-transfer-onlyStringBdsCoreNum和BdsCoreSpec实例已开通搜索引擎,只需开通BDS(LTS)引擎。

若实例是多可用区实例,请参考下表。

UpgradeType参数类型必选参数描述
upgrade-disk-sizeStringCoreSingleStorage和LogSingleStorage扩容Core单节点磁盘容量或Log单节点磁盘容量。
upgrade-lindorm-engineStringLindormSpec和LogSpec升级Core节点规格或Log节点规格。 说明 本盘类型不支持此参数变配。
upgrade-lindorm-core-numStringLindormNum和LogNum变配Core节点数量或Log节点数量。

返回参数

名称类型描述示例值
object
OrderIdlong

订单ID。

111111111111111
RequestIdstring

请求ID。

2A7D4F9D-AA26-4E15-A2B1-3E4792C6****

示例

正常返回示例

JSON格式

{
  "OrderId": 111111111111111,
  "RequestId": "2A7D4F9D-AA26-4E15-A2B1-3E4792C6****"
}

错误码

HTTP status code错误码错误信息描述
400Lindorm.Errorcode.InstanceStorageInvalidThe instance storage parameter is invalid: %s实例存储空间参数异常
400Instance.IsDeletedThe instance is deleted.操作失败,该实例已删除。
400Instance.IsNotValidThe instance is invalid.操作失败,实例无效。
403API.ForbiddenThe API operation is forbidden in this environment.操作失败,当前环境中该API无法使用。
403Lindorm.Errorcode.OperationDeniedYou are not authorized to operate on the specified resource.操作失败,请先申请指定资源的操作权限。
403Lindorm.Errorcode.ServiceLinkedRoleNoPermissionNo permission to create service linked role.操作失败,请先申请创建服务关联角色的权限。

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

变更历史

变更时间变更内容概要操作
2023-03-07OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:StreamSpec
    新增入参:StreamNum
阿里云首页 云原生多模数据库Lindorm 相关技术圈