您可以为Lindorm实例开通冷存储,对Lindorm实例进行变配和扩容。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
lindorm:UpgradeLindormInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所属的地域ID,可调用DescribeRegions接口获取。 | cn-shanghai |
ZoneId | string | 是 | 可用区ID,可调用GetLindormInstance接口获取。 | cn-shanghai-f |
InstanceId | string | 是 | 实例ID,可调用GetLindormInstanceList接口获取。 | ld-bp1o3y0yme2i2**** |
UpgradeType | string | 是 | 实例需要变配的类型,支持的变配类型请参见请求参数补充中的UpgradeType参数说明。 | upgrade-cold-storage |
ClusterStorage | integer | 否 | 变配后实例的存储容量,单位为GB,取值:480~1017600。 | 480 |
ColdStorage | integer | 否 | 变配后实例的冷存储容量,单位为GB,取值:800~1000000。 | 800 |
SolrSpec | string | 否 | 变配后实例的搜索引擎节点规格,取值:
| lindorm.g.xlarge |
SolrNum | integer | 否 | 变配后实例的搜索引擎节点数量,取值:0~60。 | 2 |
LindormSpec | string | 否 | 变配后实例的宽表引擎节点规格,取值:
| lindorm.c.xlarge |
LindormNum | integer | 否 | 变配后实例的宽表引擎节点数量,取值:0~90。 说明本参数需要和LindormSpec参数同时传入。 | 2 |
TsdbSpec | string | 否 | 变配后实例的时序引擎节点规格,取值:
| lindorm.g.xlarge |
TsdbNum | integer | 否 | 变配后实例的时序引擎节点数量,取值:0~24。 | 2 |
FilestoreSpec | string | 否 | 变配后实例的文件引擎节点规格,取值:
| lindorm.g.xlarge |
FilestoreNum | integer | 否 | 变配后实例的文件引擎节点数量,取值:0~60。 | 2 |
StreamSpec | string | 否 | 变配后实例的流引擎节点规格,取值:
| lindorm.g.xlarge |
StreamNum | integer | 否 | 变配后实例的流引擎节点数量,取值:0~90。 | 2 |
LtsCoreSpec | string | 否 | 变配后实例的LTS节点规格,取值:
| lindorm.g.xlarge |
LtsCoreNum | integer | 否 | 变配后实例的LTS节点数量,取值:0~50。 | 2 |
PhoenixCoreSpec | string | 否 | 变配后实例的Phoenix节点规格,取值:
| lindorm.c.xlarge |
PhoenixCoreNum | integer | 否 | 变配后实例的Phoenix节点数量。 | 2 |
CoreSingleStorage | integer | 否 | 多可用区实例,变配后实例的core单节点容量。取值范围400~64000,单位GB。如果目标实例是多可用区实例,选填该参数。 | 400GB |
LogSpec | string | 否 | 多可用区实例,变配后实例的log节点规格。取值如下:
如果目标实例是多可用区实例,选填该参数。 | lindorm.sn1.large |
LogNum | integer | 否 | 多可用区实例,变配后实例的log节点数量。取值范围4~400。如果目标实例是多可用区实例,选填该参数。 | 4 |
LogSingleStorage | integer | 否 | 多可用区实例,变配后实例的log单节点磁盘容量。取值范围400-64000,单位GB。如果目标实例是多可用区实例,选填该参数。 | 400GB |
UpgradeType参数说明
UpgradeLindormInstance接口中传入UpgradeType参数指定实例的变配类型后,您还需要在对应必选参数中传入配置规格,具体信息请参见下表。
UpgradeType参数 | 类型 | 必选参数 | 描述 |
---|---|---|---|
upgrade-cold-storage | String | ColdStorage | 开通或扩容冷存储。 |
upgrade-disk-size | String | ClusterStorage | 扩容云盘。 |
open-search-engine | String | 本盘类型实例:SolrNum 非本盘类型:SolrNum、SolrSpec、ClusterStorage | 开通搜索引擎。 |
upgrade-search-engine | String | SolrSpec | 升级搜索引擎规格。 说明 本盘类型不支持此参数变配。 |
upgrade-search-core-num | String | SolrNum和ClusterStorage | 变配搜索引擎节点数。 |
open-lindorm-engine | String | 本盘类型:LindormNum 非本盘类型:LindormNum、LindormSpec、ClusterStorage | 开通宽表引擎。 |
upgrade-lindorm-engine | String | LindormSpec | 升级宽表引擎规格。 说明 本盘类型不支持此参数变配。 |
upgrade-lindorm-core-num | String | LindormNum和ClusterStorage | 变配宽表引擎节点数。 |
open-tsdb-engine | String | TsdbSpec、TsdbNum、ClusterStorage | 开通时序引擎。 |
upgrade-tsdb-engine | String | TsdbSpec | 升级时序引擎规格。 说明 本盘类型不支持此参数变配。 |
upgrade-tsdb-core-num | String | TsdbNum和ClusterStorage | 变配时序引擎节点数。 |
open-stream-engine | String | StreamSpec、StreamNum、ClusterStorage | 开通流引擎。 |
upgrade-stream-engine | String | StreamSpec | 升级流引擎规格。 说明 本盘类型不支持此参数变配。 |
upgrade-stream-core-num | String | StreamNum和ClusterStorage | 变配流引擎节点数。 |
upgrade-file-engine | String | FilestoreSpec | 升级文件引擎规格。 说明 本盘类型不支持此参数变配。 |
upgrade-file-core-num | String | FilestoreNum | 变配文件引擎节点数。 |
open-bds-transfer | String | 本盘类型:BdsCoreNum、BdsCoreSpec和SolrNum 非本盘类型:BdsCoreNum、BdsCoreSpec、SolrNum和SolrSpec | 开通BDS(LTS)引擎和搜索引擎。 |
upgrade-bds-transfer | String | BdsCoreSpec | 变更BDS(LTS)引擎规格。 |
upgrade-bds-core-num | String | BdsCoreNum | 变配BDS(LTS)引擎节点数。 |
open-bds-transfer-only | String | BdsCoreNum和BdsCoreSpec | 实例已开通搜索引擎,只需开通BDS(LTS)引擎。 |
若实例是多可用区实例,请参考下表。
UpgradeType参数 | 类型 | 必选参数 | 描述 |
---|---|---|---|
upgrade-disk-size | String | CoreSingleStorage和LogSingleStorage | 扩容Core单节点磁盘容量或Log单节点磁盘容量。 |
upgrade-lindorm-engine | String | LindormSpec和LogSpec | 升级Core节点规格或Log节点规格。 说明 本盘类型不支持此参数变配。 |
upgrade-lindorm-core-num | String | LindormNum和LogNum | 变配Core节点数量或Log节点数量。 |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": 111111111111111,
"RequestId": "2A7D4F9D-AA26-4E15-A2B1-3E4792C6****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Lindorm.Errorcode.InstanceStorageInvalid | The instance storage parameter is invalid: %s | 实例存储空间参数异常 |
400 | Instance.IsDeleted | The instance is deleted. | 操作失败,该实例已删除。 |
400 | Instance.IsNotValid | The instance is invalid. | 操作失败,实例无效。 |
403 | API.Forbidden | The API operation is forbidden in this environment. | 操作失败,当前环境中该API无法使用。 |
403 | Lindorm.Errorcode.OperationDenied | You are not authorized to operate on the specified resource. | 操作失败,请先申请指定资源的操作权限。 |
403 | Lindorm.Errorcode.ServiceLinkedRoleNoPermission | No permission to create service linked role. | 操作失败,请先申请创建服务关联角色的权限。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-03-07 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | |||||||||||||
|