# Alibaba Cloud ApsaraDB for Lindorm API

> Alibaba Cloud ApsaraDB for Lindorm API on Apizie: 26 endpoints (Moves a resource to a different resource group, Creates a Lindorm instance, Creates a Lindorm V2 instance, Queries all regions where Lindorm is available, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-hitsdb`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/hitsdb
- Page: https://zieapi.vercel.app/api/cloud/aliyun-hitsdb
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-hitsdb/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for Lindorm (hitsdb, version 2020-06-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Moves a resource to a different resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The resource ID |
| ResourceRegionId | string | yes | The region ID |
| ResourceGroupId | string | yes | The ID of the destination resource group |

### Creates a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/create-lindorm-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/426062.html to query available regions. Use this… |
| ZoneId | string | yes | The zone ID of the instance |
| InstanceAlias | string | no | The name of the instance |
| InstanceStorage | string | no | The storage capacity of the instance. Unit: GB |
| PayType | string | yes | The billing method of the instance. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go |
| VPCId | string | yes | The VPC ID of the instance |
| VSwitchId | string | yes | The vSwitch ID |
| PricingCycle | string | no | The billing cycle of the instance. Valid values: Month: monthly billing. Year: yearly billing. This parameter is available and required… |
| Duration | string | no | The subscription duration of the instance. Valid values: If PricingCycle is set to Month, valid values are 1 to 9. If PricingCycle is set… |
| DiskCategory | string | yes | The storage type of the instance. Valid values: cloud_efficiency: standard cloud storage. cloud_ssd: performance cloud storage.… |
| CoreSpec | string | no | The node specifications for local disk type of the instance. When the local storage type is local_ssd_pro, valid values are as follows. I3… |
| LindormNum | integer | no | The number of LindormTable engine nodes of the instance. To create a single-zone instance, valid values are 0 to 90. To create a… |
| SolrSpec | string | no | The search index engine node specifications of the instance. Valid values: lindorm.g.xlarge: 4 cores, 16 GB (dedicated).… |
| SolrNum | integer | no | The number of search index engine nodes of the instance. Valid values: 0 to 60 |
| ColdStorage | integer | no | The capacity cloud storage capacity of the instance. Unit: GB. If this parameter is not specified, capacity cloud storage is not enabled.… |
| TsdbSpec | string | no | The LindormTSDB engine node specifications of the instance. Valid values: lindorm.g.xlarge: 4 cores, 16 GB (dedicated). lindorm.g.2xlarge:… |
| TsdbNum | integer | no | The number of LindormTSDB engine nodes of the instance. Valid values: If the billing method of the instance is PREPAY, valid values are 0… |
| LindormSpec | string | no | The LindormTable engine node specifications of the instance. Valid values: lindorm.g.xlarge: 4 cores, 16 GB (dedicated).… |
| FilestoreNum | integer | no | The number of file engine nodes of the instance. Valid values: If the billing method of the instance is PREPAY, valid values are 0 to 60.… |
| FilestoreSpec | string | no | The file engine node specifications of the instance. Valid values: lindorm.c.xlarge: 4 cores, 8 GB (standard) |
| StreamNum | integer | no | The number of stream engine nodes of the instance. Valid values: 0 to 60 |
| StreamSpec | string | no | The stream engine node specifications of the instance. Valid values: lindorm.g.xlarge: 4 cores, 16 GB (dedicated). lindorm.c.2xlarge: 8… |
| ArchVersion | string | no | The deployment architecture. Valid values: 1.0: single-zone. 2.0: multi-zone. If this parameter is not specified, the default value is… |
| PrimaryZoneId | string | no | The zone ID of the primary zone for a multi-zone instance. To create a multi-zone instance, this parameter is required |
| StandbyZoneId | string | no | The zone ID of the secondary zone for a multi-zone instance. To create a multi-zone instance, this parameter is required |
| ArbiterZoneId | string | no | The zone ID of the arbiter zone for a multi-zone instance. To create a multi-zone instance, this parameter is required |
| MultiZoneCombination | string | no | The multi-zone combination. You can check the supported zone combinations on the buy page. ap-southeast-5abc-aliyun: Indonesia (Jakarta)… |
| PrimaryVSwitchId | string | no | The vSwitch ID of the primary zone for a multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId. To create a… |
| StandbyVSwitchId | string | no | The vSwitch ID of the secondary zone for a multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId. To create a… |
| ArbiterVSwitchId | string | no | The vSwitch ID of the arbiter zone for a multi-zone instance. The vSwitch must be in the zone specified by ArbiterZoneId. To create a… |
| CoreSingleStorage | integer | no | The storage capacity per core node for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. To create a multi-zone instance, this… |
| LogDiskCategory | string | no | The disk type of log nodes for a multi-zone instance. Valid values: cloud_efficiency: standard cloud storage. cloud_ssd: performance cloud… |
| LogSpec | string | no | The log node specifications for a multi-zone instance. Valid values: lindorm.sn1.large: 4 cores, 8 GB (dedicated). lindorm.sn1.2xlarge: 8… |
| LogNum | integer | no | The number of log nodes for a multi-zone instance. Valid values: 4 to 400. To create a multi-zone instance, this parameter is required |
| LogSingleStorage | integer | no | The storage capacity per log node for a multi-zone instance. Valid values: 400 to 64000. Unit: GB. To create a multi-zone instance, this… |
| ResourceGroupId | string | no | The resource group ID |
| AutoRenewal | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.… |
| AutoRenewDuration | string | no | The auto-renewal duration. Unit: months. Valid values: 1 to 12. This parameter takes effect only when AutoRenewal is set to true |
| LtsSpec | string | no | The LTS engine node specifications of the instance. Valid values: lindorm.c.xlarge: 4 cores, 8 GB (dedicated). lindorm.g.xlarge: 4 cores,… |
| LtsNum | string | no | The number of LTS engine nodes of the instance. Valid values: 0 to 60 |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates a Lindorm V2 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/create-lindorm-v2-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/426062.html operation to query the most recent… |
| ZoneId | string | yes | The zone ID of the instance |
| InstanceAlias | string | no | The name of the instance |
| CloudStorageType | string | no | The storage type. If you select big data or local SSD, you do not need to specify this parameter. Valid values: PerformanceStorage:… |
| PayType | string | yes | The billing method of the instance. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go |
| VPCId | string | yes | The VPC ID of the instance |
| VSwitchId | string | no | The vSwitch ID |
| PricingCycle | string | no | The billing cycle of the instance. Valid values: Month: month. Year: year. This parameter is available and required only when PayType is… |
| Duration | integer | no | The subscription duration of the instance. Valid values: If PricingCycle is set to Month, the value ranges from 1 to 9. If PricingCycle is… |
| CloudStorageSize | integer | no | The size of the cloud storage space. Unit: GB |
| ArchVersion | string | no | The deployment architecture. Valid values: 1.0: single-zone. 2.0: multi-zone basic edition. 3.0: multi-zone high-availability edition |
| PrimaryZoneId | string | no | The zone ID of the primary zone for a multi-zone instance. This parameter is required if you want to create a multi-zone instance |
| StandbyZoneId | string | no | The zone ID of the secondary zone for a multi-zone instance. This parameter is required if you want to create a multi-zone instance |
| ArbiterZoneId | string | no | The zone ID of the arbiter zone for a multi-zone instance. This parameter is required if you want to create a multi-zone instance |
| PrimaryVSwitchId | string | no | The vSwitch ID of the primary zone for a multi-zone instance. The vSwitch must be deployed in the zone specified by PrimaryZoneId. This… |
| StandbyVSwitchId | string | no | The vSwitch ID of the secondary zone for a multi-zone instance. The vSwitch must be deployed in the zone specified by StandbyZoneId. This… |
| ArbiterVSwitchId | string | no | The vSwitch ID of the arbiter zone for a multi-zone instance. The vSwitch must be deployed in the zone specified by ArbiterZoneId. This… |
| ResourceGroupId | string | no | The resource group ID |
| AutoRenewal | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default… |
| AutoRenewDuration | string | no | The auto-renewal duration. Unit: month. Valid values: 1 to 12. This parameter takes effect only when AutoRenewal is set to true |
| ClusterPattern | string | no | The cluster pattern. Valid values: basic: production |
| ClusterMode | string | no | The instance mode. This parameter is optional. BASIC: general mode |
| EnableCapacityStorage | string | no | Specifies whether to enable capacity storage |
| CapacityStorageSize | integer | no | The size of the capacity storage. Unit: GB |
| EngineList | string | yes | The list of engine information (JSON-encoded) |

### Queries all regions where Lindorm is available
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | no | The language to use for the region name (LocalName) in the response. Valid values: zh-CN: Chinese. This is the default value. en-US: English |

### Retrieves the access whitelist for a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-instance-ip-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. To obtain the ID, call the https://help.aliyun.com/document_detail/426068.html operation |

### Retrieves a summary of Lindorm instances in your account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-instance-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### Retrieves the storage details of each storage medium for a specific Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-fs-used-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. You can call https://help.aliyun.com/document_detail/426062.html to query the region ID |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/426069.html to query the instance ID |

### Retrieves the details of a Lindorm instance, including the instance type, billing method, and VPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/426069.html to retrieve the instance ID |

### Queries the engine types that a Lindorm instance supports
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-instance-engine-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| InstanceId | string | yes | The ID of the instance. To obtain the instance ID, call the https://help.aliyun.com/document_detail/426069.html operation |

### Retrieves a list of Lindorm instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/426062.html operation to query the region ID |
| QueryStr | string | no | The keyword of the instance name. Fuzzy match is supported |
| PageNumber | integer | no | The page number of the page to return |
| PageSize | integer | no | The number of entries per page for a paged query |
| ServiceType | string | no | The instance type. Valid values: lindorm: a Lindorm single-zone instance. lindorm_multizone: a Lindorm multi-zone instance.… |
| SupportEngine | integer | no | The type of data engine supported by the queried instance. Valid values: 1: The search index engine is supported. 2: LindormTSDB is… |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Queries the details of a Lindorm V2 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-v2-instance-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. This operation supports only Lindorm V2 architecture instances where ServiceType is lindorm_v2, lindorm_v2_multizone, or… |

### Retrieves the storage details of each storage medium for a specific Lindorm instance with the new architecture
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/get-lindorm-v2-storage-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Get Lindorm instance-to-tag bindings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance is located. Call the https://help.aliyun.com/document_detail/426062.html operation to get a list… |
| ResourceId | string | no | A list of resource IDs (JSON-encoded) |
| NextToken | string | no | The token to retrieve the next page of results. Do not specify this parameter for your first request. If the response returns a NextToken,… |
| ResourceType | string | yes | The resource type. Set the value to INSTANCE |
| Tag | string | no | A list of tags (JSON-encoded) |

### Changes the billing method of a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/modify-instance-pay-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| Duration | integer | no | The subscription duration. This parameter is required when you change the billing method to subscription. If \`PricingCycle\` is… |
| PricingCycle | string | no | The unit of the subscription duration. This parameter is required when you change the billing method to subscription. Month: The unit is… |
| PayType | string | yes | The billing method of the instance. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go |

### Releases a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/release-lindorm-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/426069.html operation to obtain the instance ID |
| Immediately | string | no | Specifies whether to release the instance immediately. If set to true, the instance and its data are deleted immediately. If set to false… |

### Releases a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/release-lindorm-v2-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. Call the https://help.aliyun.com/document_detail/190281.html operation to obtain the instance ID |
| Immediately | string | no | Specifies whether to immediately release the instance. Default value: false. If this parameter is set to false, the instance data is… |

### Renews a subscription Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/renew-lindorm-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/426062.html operation to query the region ID |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/426069.html operation to query the instance ID. The… |
| PricingCycle | string | yes | The billing cycle of the instance. Valid values: Month: months Year: years |
| Duration | integer | yes | The subscription duration of the instance. Valid values: If PricingCycle is set to Month, the instance is billed by month. Valid values: 1… |

### Enables or disables the Lindorm MySQL-compatible protocol
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/switch-lsqlv3-my-sqlservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ActionType | integer | yes | The operation type. Valid values: 1: Enable. 0: Disable |

### Attaches tags to one or more Lindorm instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. Call the https://help.aliyun.com/document_detail/426062.html operation to obtain the region ID |
| ResourceType | string | yes | The type of the resource. Set the value to INSTANCE |
| ResourceId | string | yes | A list of resource IDs (JSON-encoded) |
| Tag | string | yes | A list of tags (JSON-encoded) |

### Detaches tags from Lindorm instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| ResourceType | string | yes | The resource type. The value is fixed to INSTANCE |
| ResourceId | string | yes | A list of instance IDs (JSON-encoded) |
| TagKey | string | no | A list of tag keys (JSON-encoded) |
| All | string | no | Specifies whether to detach all tags from the instances. Valid values: true: Detach all tags from the instances. false: Do not detach all… |

### Sets the access whitelist for a Lindorm instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/update-instance-ip-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. Call the https://help.aliyun.com/document_detail/426069.html operation to obtain the ID |
| SecurityIpList | string | yes | The IP addresses to add to the whitelist. Set this parameter to 127.0.0.1 to deny access from all IP addresses. For example,… |
| GroupName | string | no | The name of the whitelist group. If you leave this parameter empty, the default value user is used |
| Delete | string | no | Specifies whether to clear the whitelist |

### Updates the instance name or deletion protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/update-lindorm-instance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| InstanceAlias | string | no | The instance name |
| DeletionProtection | string | no | Specifies whether to enable deletion protection. Valid values: true: Enabled. false: Disabled |
| DispositionType | string | no | The risk disposition type for a single zone |
| PlannedCompletionDate | string | no | The planned completion date for risk disposition, in the yyyy-MM-dd format |

### Updates a Lindorm V2 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/update-lindorm-v2-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/426062.html operation to query the region ID. Use… |
| CloudStorageType | string | no | The cloud storage type. Valid values: PerformanceStorage: Performance cloud storage. StandardStorage: Standard cloud storage |
| CloudStorageSize | integer | no | The cloud storage space. Unit: GB. When you modify the cloud storage space, you must also specify EngineList. The EngineType parameter in… |
| EnableCapacityStorage | string | no | Specifies whether to enable capacity storage |
| CapacityStorageSize | integer | no | The capacity storage space |
| EngineList | string | yes | The list of engine types (JSON-encoded) |
| InstanceId | string | yes | The instance ID |

### Modifies the IP whitelists for a LindormV2 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/update-lindorm-v2-white-ip-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the instance is located. You can call the https://help.aliyun.com/document_detail/426062.html operation to… |
| InstanceId | string | yes | The ID of the instance. You can call the GetLindormV2InstanceList operation to obtain the instance ID |
| WhiteIpGroupList | string | yes | The list of IP whitelist groups (JSON-encoded) |

### Enables cold storage for a Lindorm instance, changes node specifications or node counts, or changes the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/upgrade-lindorm-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/426062.html operation to query the region ID |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/426067.html operation to query the zone ID |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/426069.html operation to query the instance ID |
| UpgradeType | string | yes | The type of specification change for the instance. For supported types, see the UpgradeType parameter description in the request… |
| ClusterStorage | integer | no | The storage capacity of the instance after the specification change. Unit: GB. Valid values: 480 to 1017600 |
| ColdStorage | integer | no | The cold storage capacity of the instance after the specification change. Unit: GB. Valid values: 800 to 1000000 |
| 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… |
| SolrNum | integer | no | The number of search index engine nodes of the instance after the specification change. Valid values: 0 to 60 |
| LindormSpec | string | no | The LindormTable engine node specifications of the instance after the specification change. Valid values: lindorm.c.xlarge: 4 cores and 8… |
| LindormNum | integer | no | The number of LindormTable nodes of the instance after the specification change. Valid values: 0 to 90. This parameter must be specified… |
| TsdbSpec | string | no | The LindormTSDB engine node specifications of the instance after the specification change. Valid values: lindorm.g.xlarge: 4 cores and 16… |
| TsdbNum | integer | no | The number of LindormTSDB nodes of the instance after the specification change. Valid values: 0 to 24 |
| 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… |
| FilestoreNum | integer | no | The number of file engine nodes of the instance after the specification change. Valid values: 0 to 60 |
| 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… |
| StreamNum | integer | no | The number of stream engine nodes of the instance after the specification change. Valid values: 0 to 90 |
| 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… |
| LtsCoreNum | integer | no | The number of LTS nodes of the instance after the specification change. Valid values: 0 to 50 |
| 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.… |
| 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… |
| 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… |
| 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:… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hitsdb.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/change-resource-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for Lindorm API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-hitsdb/change-resource-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraDB for Lindorm API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraDB for Lindorm itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraDB for Lindorm API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-hitsdb.

### What is the status of the Alibaba Cloud ApsaraDB for Lindorm API?
Needs your own provider key (bring your own key)