文档

UpgradeLindormInstance - 变配Lindorm实例

更新时间:

为Lindorm实例开通冷存储,变更节点规格或节点数量,变更存储空间。

接口说明

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

调试

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

授权信息

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

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

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

indorm.c.xlarge:表示 4 核 8GB(标准规格)。

lindorm.c.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
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本盘类型:LtsCoreNum、LtsCoreSpec 和 SolrNum
非本盘类型:LtsCoreNum、LtsCoreSpec、SolrNum 和 SolrSpec
开通 BDS(LTS)引擎和搜索引擎。
upgrade-bds-transferStringLtsCoreSpec变更 BDS(LTS)引擎规格。
upgrade-bds-core-numStringLtsCoreNum变配 BDS(LTS)引擎节点数。
open-bds-transfer-onlyStringLtsCoreNum 和 LtsCoreSpec实例已开通搜索引擎,只需开通 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.操作失败,实例无效。
400InstanceConfig.NotChangedThe upgrade or downgrade configuration is not changed, please check.升级或降配的配置未改变,请重新选择
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.操作失败,请先申请创建服务关联角色的权限。
403Instance.NotActiveInstance is not active.实例状态不是运行中
403OperationDenied.OrderProcessingOrder in process, please try again later.存在处理中的订单,请稍后重试

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

变更历史

变更时间变更内容概要操作
2024-02-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
2023-12-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
2023-09-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    删除入参:PhoenixCoreSpec
    删除入参:PhoenixCoreNum
2023-07-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    删除入参:MlSpec
    删除入参:MlNum
2023-04-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:MlSpec
    新增入参:MlNum
2023-03-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:StreamSpec
    新增入参:StreamNum
  • 本页导读 (1)
文档反馈