Scale Lindorm Node Specs and Storage via OpenAPI - Lindorm - Alibaba Cloud - Lindorm

Enables cold storage for a Lindorm instance, changes node specifications or node counts, or changes the storage capacity.

Operation description

For information about data engines and storage specifications of Lindorm instances, see How to select a data engine and How to select a storage specification.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

lindorm:UpgradeLindormInstance

update

*Instance

acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
ZoneId	string	Yes	The zone ID. You can call the GetLindormInstance operation to query the zone ID.	cn-shanghai-f
InstanceId	string	Yes	The instance ID. You can call the GetLindormInstanceList operation to query the instance ID.	ld-bp1o3y0yme2i2****
UpgradeType	string	Yes	The type of specification change for the instance. For supported types, see the UpgradeType parameter description in the request parameters supplement.	upgrade-cold-storage
ClusterStorage	integer	No	The storage capacity of the instance after the specification change. Unit: GB. Valid values: 480 to 1017600.	480
ColdStorage	integer	No	The cold storage capacity of the instance after the specification change. Unit: GB. Valid values: 800 to 1000000.	800
SolrSpec	string	No	The search index engine node specifications of the instance after the specification change. Valid values: lindorm.g.xlarge: 4 cores and 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 cores and 32 GB of memory (dedicated specification). lindorm.g.4xlarge: 16 cores and 64 GB of memory (dedicated specification). lindorm.g.8xlarge: 32 cores and 128 GB of memory (dedicated specification).	lindorm.g.xlarge
SolrNum	integer	No	The number of search index engine nodes of the instance after the specification change. Valid values: 0 to 60.	2
LindormSpec	string	No	The LindormTable engine node specifications of the instance after the specification change. Valid values: lindorm.c.xlarge: 4 cores and 8 GB of memory (dedicated specification). lindorm.c.2xlarge: 8 cores and 16 GB of memory (dedicated specification). lindorm.c.4xlarge: 16 cores and 32 GB of memory (dedicated specification). lindorm.c.8xlarge: 32 cores and 64 GB of memory (dedicated specification).	lindorm.c.xlarge
LindormNum	integer	No	The number of LindormTable nodes of the instance after the specification change. Valid values: 0 to 90. Note This parameter must be specified together with the LindormSpec parameter.	2
TsdbSpec	string	No	The LindormTSDB engine node specifications of the instance after the specification change. Valid values: lindorm.g.xlarge: 4 cores and 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 cores and 32 GB of memory (dedicated specification). lindorm.g.4xlarge: 16 cores and 64 GB of memory (dedicated specification). lindorm.g.8xlarge: 32 cores and 128 GB of memory (dedicated specification).	lindorm.g.xlarge
TsdbNum	integer	No	The number of LindormTSDB nodes of the instance after the specification change. Valid values: 0 to 24.	2
FilestoreSpec	string	No	The file engine node specifications of the instance after the specification change. Valid values: indorm.c.xlarge: 4 cores and 8 GB of memory (standard specification).	lindorm.c.xlarge
FilestoreNum	integer	No	The number of file engine nodes of the instance after the specification change. Valid values: 0 to 60.	2
StreamSpec	string	No	The stream engine node specifications of the instance after the specification change. Valid values: lindorm.c.2xlarge: 8 cores and 16 GB of memory (dedicated specification). lindorm.c.4xlarge: 16 cores and 32 GB of memory (dedicated specification). lindorm.c.8xlarge: 32 cores and 64 GB of memory (dedicated specification).	lindorm.g.xlarge
StreamNum	integer	No	The number of stream engine nodes of the instance after the specification change. Valid values: 0 to 90.	2
LtsCoreSpec	string	No	The LTS node specifications of the instance after the specification change. Valid values: lindorm.g.xlarge: 4 cores and 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 cores and 32 GB of memory (dedicated specification).	lindorm.g.xlarge
LtsCoreNum	integer	No	The number of LTS nodes of the instance after the specification change. Valid values: 0 to 50.	2
CoreSingleStorage	integer	No	The storage capacity per core node of the instance after the specification change for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. Specify this parameter if the target instance is a multi-zone instance.	400
LogSpec	string	No	The log node specifications of the instance after the specification change for a multi-zone instance. Valid values: lindorm.sn1.large: 4 cores and 8 GB of memory (dedicated specification). lindorm.sn1.2xlarge: 8 cores and 16 GB of memory (dedicated specification). Specify this parameter if the target instance is a multi-zone instance.	lindorm.sn1.large
LogNum	integer	No	The number of log nodes of the instance after the specification change for a multi-zone instance. Valid values: 4 to 400. Specify this parameter if the target instance is a multi-zone instance.	4
LogSingleStorage	integer	No	The disk capacity per log node of the instance after the specification change for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. Specify this parameter if the target instance is a multi-zone instance.	400

UpgradeType parameter description

After you specify the UpgradeType parameter in the UpgradeLindormInstance operation to define the specification change type, you must also specify the configuration in the corresponding required parameters. For more information, see the following table.

UpgradeType parameter	Type	Required parameters	Description
upgrade-cold-storage	String	ColdStorage	Enables or scales out cold storage.
upgrade-disk-size	String	ClusterStorage	Scales out cloud disks.
open-search-engine	String	Local disk instance: SolrNum Non-local disk instance: SolrNum, SolrSpec, and ClusterStorage	Enables the search search engine.
upgrade-search-engine	String	SolrSpec	Upgrades the search search engine specification. Note This specification change is not supported for local disk instances.
upgrade-search-core-num	String	SolrNum and ClusterStorage	Changes the number of search search engine nodes.
open-lindorm-engine	String	Local disk instance: LindormNum Non-local disk instance: LindormNum, LindormSpec, and ClusterStorage	Enables the LindormTable engine.
upgrade-lindorm-engine	String	LindormSpec	Upgrades the LindormTable engine specification. Note This specification change is not supported for local disk instances.
upgrade-lindorm-core-num	String	LindormNum and ClusterStorage	Changes the number of LindormTable engine nodes.
open-tsdb-engine	String	TsdbSpec, TsdbNum, and ClusterStorage	Enables the LindormTSDB engine.
upgrade-tsdb-engine	String	TsdbSpec	Upgrades the LindormTSDB engine specification. Note This specification change is not supported for local disk instances.
upgrade-tsdb-core-num	String	TsdbNum and ClusterStorage	Changes the number of LindormTSDB engine nodes.
open-stream-engine	String	StreamSpec, StreamNum, and ClusterStorage	Enables the stream engine.
upgrade-stream-engine	String	StreamSpec	Upgrades the stream engine specification. Note This specification change is not supported for local disk instances.
upgrade-stream-core-num	String	StreamNum and ClusterStorage	Changes the number of stream engine nodes.
upgrade-file-engine	String	FilestoreSpec	Upgrades the file engine specification. Note This specification change is not supported for local disk instances.
upgrade-file-core-num	String	FilestoreNum	Changes the number of file engine nodes.
open-bds-transfer	String	Local disk instance: LtsCoreNum, LtsCoreSpec, and SolrNum Non-local disk instance: LtsCoreNum, LtsCoreSpec, SolrNum, and SolrSpec	Enables the BDS (LTS) engine and the search search engine.
upgrade-bds-transfer	String	LtsCoreSpec	Changes the BDS (LTS) engine specification.
upgrade-bds-core-num	String	LtsCoreNum	Changes the number of BDS (LTS) engine nodes.
open-bds-transfer-only	String	LtsCoreNum and LtsCoreSpec	Enables only the BDS (LTS) engine when the search search engine is already enabled for the instance.

If the instance is a multi-zone instance, refer to the following table.

UpgradeType parameter	Type	Required parameters	Description
upgrade-disk-size	String	CoreSingleStorage and LogSingleStorage	Scales out the disk capacity per core node or per log node.
upgrade-lindorm-engine	String	LindormSpec and LogSpec	Upgrades the core node specifications or log node specifications. Note This specification change is not supported for local disk instances.
upgrade-lindorm-core-num	String	LindormNum and LogNum	Changes the number of core nodes or log nodes.

Response elements

Element	Type	Description	Example
	object
OrderId	integer	The order ID.	111111111111111
RequestId	string	The request ID.	2A7D4F9D-AA26-4E15-A2B1-3E4792C6****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.InstanceStorageInvalid	The instance storage parameter is invalid: %s
400	Instance.IsDeleted	The instance is deleted.	The specified instance is already deleted.
400	Instance.IsNotValid	The instance is invalid.	The specified instance is invalid.
400	InstanceConfig.NotChanged	The upgrade or downgrade configuration is not changed, please check.	The upgrade or downgrade configuration is not changed, please check.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.	You are not authorized to manage the specified resource.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.
403	Instance.NotActive	Instance is not active.	Instance status is not running
403	OperationDenied.OrderProcessing	Order in process, please try again later.	Order in process, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.