API standards and multilingual preset SDKs
The OpenAPI of this product (hitsdb/2020-06-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Region
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries all regions where Lindorm is available. |
Instance
|
API |
Title |
Description |
| CreateLindormInstance | CreateLindormInstance | Create a Lindorm instance. |
| ReleaseLindormInstance | ReleaseLindormInstance | Releases a Lindorm instance. |
| UpgradeLindormInstance | UpgradeLindormInstance | Enable cold storage for a Lindorm instance, change the node specification or the number of nodes, and adjust the storage space. |
| GetLindormInstance | Retrieve lindorm instance details | Retrieves the details of a Lindorm instance, including the instance type, billing method, and VPC information. |
| GetLindormInstanceEngineList | GetLindormInstanceEngineList | Queries the engine types that a Lindorm instance supports. |
| GetLindormInstanceList | GetLindormInstanceList | Queries 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. |
Whitelist
|
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 | Get Lindorm instance-to-tag bindings. |
| 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. |
| GetInstanceSummary | GetInstanceSummary | Retrieves a summary of Lindorm instances in your account. |
| GetLindormFsUsedDetail | GetLindormFsUsedDetail | Retrieves the storage details for each storage medium in a specified Lindorm instance. |
| GetLindormV2StorageUsage | Retrieve storage details of a lindorm V2 instance | Retrieves the storage details of each storage medium for a specific Lindorm instance with the new architecture. |
| ReleaseLindormV2Instance | ReleaseLindormV2Instance | Releases a Lindorm instance. |
| UpdateLindormV2Instance | UpdateLindormV2Instance | Updates a Lindorm instance. |
| UpdateLindormInstanceAttribute | Update instance name or deletion protection | Updates the instance name or deletion protection. |
| GetLindormV2InstanceDetails | GetLindormV2InstanceDetails | Queries the details of an instance that uses the new architecture. |
| UpdateLindormV2WhiteIpList | UpdateLindormV2WhiteIpList | Modifies the IP whitelists for a LindormV2 instance. |