Upgrades, scales up, or enable cold storage for a Lindorm instance.
Operation description
For more information about how to select the storage type and engine type when you create a Lindorm instance, see Select engine typpes and Select storage types.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| lindorm:UpgradeLindormInstance | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region in which the instance that you want to upgrade, scale up, or enable cold storage is located. You can call the DescribeRegions operation to query the region ID. | cn-shanghai |
| ZoneId | string | Yes | The ID of the zone in which the instance that you want to upgrade, scale up, or enable cold storage is located. You can call the GetLindormInstance operation to query the zone ID. | cn-shanghai-f |
| InstanceId | string | Yes | The ID of the instance that you want to upgrade, scale up, or enable cold storage. You can call the GetLindormInstanceList operation to query the instance ID. | ld-bp1o3y0yme2i2**** |
| UpgradeType | string | Yes | The upgrade type of the operation. For more information about upgrade types, see the UpgradeType parameters section. | upgrade-cold-storage |
| ClusterStorage | integer | No | The storage capacity of the instance after it is upgraded. Unit: GB. Valid values: 480 to 1017600. | 480 |
| ColdStorage | integer | No | The cold storage capacity of the instance after it is upgraded. Unit: GB. Valid values: 800 to 1000000. | 800 |
| SolrSpec | string | No | The specification of LindormSearch nodes in the instance after the instance is upgraded. Valid values:
| lindorm.g.xlarge |
| SolrNum | integer | No | The number of LindormSearch nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 60. | 2 |
| LindormSpec | string | No | The specification of LindormTable nodes in the instance after the instance is upgraded. Valid values:
| lindorm.c.xlarge |
| LindormNum | integer | No | The number of LindormTable nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 90. Note
This parameter must be specified together with the LindormSpec parameter.
| 2 |
| TsdbSpec | string | No | The specification of LindormTSDB nodes in the instance after the instance is upgraded. Valid values:
| lindorm.g.xlarge |
| TsdbNum | integer | No | The number of LindormTSDB nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 24. | 2 |
| FilestoreSpec | string | No | The specification of LindormDFS nodes in the instance after the instance is upgraded. Valid values:
| lindorm.g.xlarge |
| FilestoreNum | integer | No | The number of LindormDFS nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 60. | 2 |
| StreamSpec | string | No | The specification of LindormStream nodes in the instance after the instance is upgraded. Valid values:
| lindorm.g.xlarge |
| StreamNum | integer | No | The number of LindormStream nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 60. | 2 |
| LtsCoreSpec | string | No | The specification of Lindorm Tunnel Service (LTS) nodes in the instance after the instance is upgraded. Valid values:
| lindorm.g.xlarge |
| LtsCoreNum | integer | No | The number of LTS nodes in the instance after the instance is upgraded. Valid values: integers from 0 to 50. | 2 |
| CoreSingleStorage | integer | No | The storage capacity of a single core node in the instance after the instance upgraded. This parameter is available only if the instance you want to upgrade is a multi-zone instance. Unit: GB. Valid values: 400 to 64000. This parameter is optional. | 400 |
| LogSpec | string | No | The specification of log nodes in the instance after the instance is upgraded. This parameter is available only if the instance you want to upgrade is a multi-zone instance. Valid values:
This parameter is optional. | lindorm.sn1.large |
| LogNum | integer | No | The number of log nodes in the instance after the instance is upgraded. This parameter is available only if the instance you want to upgrade is a multi-zone instance. This parameter is optional. | 4 |
| LogSingleStorage | integer | No | The storage capacity of a single log node in the instance after the instance upgraded. This parameter is available only if the instance you want to upgrade is a multi-zone instance. This parameter is optional. | 400 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-02-19 | The Error code has changed | see changesets | ||||||||||||
| ||||||||||||||
| 2023-12-11 | The Error code has changed | see changesets | ||||||||||||
| ||||||||||||||
| 2023-09-08 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
| 2023-07-03 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
| 2023-04-14 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
| 2023-03-07 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
|