API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (hitsdb/2020-06-15) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Area
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries all regions where Lindorm is available. |
Instance
|
API |
Title |
Description |
| CreateLindormInstance | CreateLindormInstance | Creates a Lindorm instance. |
| ReleaseLindormInstance | ReleaseLindormInstance | Releases a Lindorm instance. |
| UpgradeLindormInstance | UpgradeLindormInstance | Enables cold storage for a Lindorm instance, or changes the node specifications, the number of nodes, or the storage capacity. |
| GetLindormInstance | GetLindormInstance | Retrieves the details of a Lindorm instance, including the instance type, billing method, and the virtual private cloud (VPC) in which the instance is deployed. |
| GetLindormInstanceEngineList | GetLindormInstanceEngineList | Queries the engine types that a Lindorm instance supports. |
| GetLindormInstanceList | GetLindormInstanceList | Retrieves a list of Lindorm instances. |
| RenewLindormInstance | RenewLindormInstance | Renews a subscription Lindorm instance. |
| ModifyInstancePayType | ModifyInstancePayType | Changes the billing method of a Lindorm instance. |
| SwitchLSQLV3MySQLService | SwitchLSQLV3MySQLService | Enables or disables the Lindorm protocol that is compatible with MySQL. |
Whitelists
|
API |
Title |
Description |
| UpdateInstanceIpWhiteList | UpdateInstanceIpWhiteList | Sets the access whitelist for a Lindorm instance. |
| GetInstanceIpWhiteList | GetInstanceIpWhiteList | Retrieves the access whitelist for a Lindorm instance. |
Tag
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries for Lindorm instances and their associated tags. |
| TagResources | TagResources | Attaches tags to one or more Lindorm instances. |
| UntagResources | UntagResources | Detaches tags from Lindorm instances. |
Other
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource to a different resource group. |
| CreateLindormV2Instance | CreateLindormV2Instance | Creates a Lindorm V2 instance. |
| GetLindormFsUsedDetail | GetLindormFsUsedDetail | Retrieves the storage usage details for each storage medium of a specific Lindorm instance. |
| ReleaseLindormV2Instance | ReleaseLindormV2Instance | Releases a Lindorm instance. |
| UpdateLindormV2Instance | UpdateLindormV2Instance | Updates a Lindorm instance. |
Others
|
API |
Title |
Description |
| GetLindormV2InstanceDetails | GetLindormV2InstanceDetails | Queries the details of a new architecture instance. |
| UpdateLindormInstanceAttribute | UpdateLindormInstanceAttribute | Updates the name or deletion protection settings of an instance. |
| UpdateLindormV2WhiteIpList | UpdateLindormV2WhiteIpList | Updates the IP whitelist for a LindormV2 instance. |