# Alibaba Cloud ApsaraDB for Cassandra API

> Alibaba Cloud ApsaraDB for Cassandra API on Apizie: 54 endpoints (Allocates public contact points, Creates a backup plan, Creates a Cassandra instance, Adds a data center to a cluster, …) 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-cassandra/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for ApsaraDB for Cassandra (cassandra, version 2019-01-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Allocates public contact points
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/allocate-public-contact-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID of the cluster |
| ClientToken | string | no | The ClientToken |

### Creates a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/create-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the cluster |
| DataCenterId | string | yes | The data center ID of the cluster |
| BackupTime | string | yes | The daily start time for backups in UTC. The time must end with Z |
| BackupPeriod | string | no | The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday |
| RetentionPeriod | integer | no | The retention period for the backup plan, in days. Valid values: 1 to 7 |
| Active | string | no | Specifies whether to activate the backup plan |
| ClientToken | string | no | The ClientToken |

### Creates a Cassandra instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/create-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| PayType | string | yes | The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go Pay-as-you-go instances do not have an expiration… |
| PeriodUnit | string | no | The billing cycle unit for subscription instances. Valid values: Year: year Month: month This parameter is required when PayType is set to… |
| Period | integer | no | The subscription period in months. This parameter is required when PayType is set to Subscription. Valid values: 1 to 9, 12, 24, and 36.… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal false: disables auto-renewal Default value: false |
| AutoRenewPeriod | integer | no | The auto-renewal epoch in months. Valid values: 1 2 3 6 12 This parameter is required when AutoRenew is set to true |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. The value is generated by the client and must be unique among different… |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to view available region IDs |
| ZoneId | string | yes | The zone ID. You can call the DescribeRegions operation to query available zones and use this parameter to specify the zone where the… |
| ClusterName | string | no | The cluster name. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character and can contain… |
| DataCenterName | string | no | The data center name |
| MajorVersion | string | yes | The major version number |
| InstanceType | string | yes | The instance type of the cluster. Examples of valid values: cassandra.c.large: 2 vCPUs and 4 GB of memory cassandra.c.xlarge: 4 vCPUs and… |
| NodeCount | integer | yes | The number of nodes |
| DiskType | string | no | The disk storage type. Examples of valid values: cloud_ssd: standard SSD cloud_essd: ESSD cloud_efficiency: ultra disk local_ssd_pro:… |
| DiskSize | integer | no | The disk storage size per node. Unit: GB |
| VpcId | string | yes | The ID of the VPC |
| VswitchId | string | yes | The ID of the vSwitch |
| Password | string | no | The password. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase… |
| ResourceGroupId | string | no | The ID of the resource group. If you do not specify this parameter, the instance is added to the default resource group. You can view the… |

### Adds a data center to a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/create-data-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| PayType | string | yes | The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. Pay-as-you-go instances do not expire |
| PeriodUnit | string | no | The billing cycle of the subscription instance. Valid values: Year: year. Month: month. This parameter is required when PayType is set to… |
| Period | integer | no | The subscription period. This parameter is required when PayType is set to Subscription. Unit: months. Valid values: 1 to 9, 12, 24, and… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false |
| AutoRenewPeriod | integer | no | The auto-renewal epoch. Unit: months. Valid values: 1 2 3 6 12 This parameter is required when AutoRenew is set to true |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to view available region IDs |
| ZoneId | string | yes | The zone ID. You can call the DescribeRegions operation to query available zone IDs. Use this parameter to specify the zone where you want… |
| ClusterId | string | yes | The cluster ID |
| DataCenterName | string | no | The name of the data center |
| InstanceType | string | yes | The instance type of the cluster. Examples of valid values: cassandra.c.large: 2 vCPUs and 4 GiB of memory. Gcassandra.c.xlarge: 4 vCPUs… |
| NodeCount | integer | yes | The number of nodes |
| DiskType | string | no | The disk storage type. Examples of valid values: cloud_ssd: standard SSD. cloud_essd: ESSD. cloud_efficiency: ultra disk. local_ssd_pro:… |
| DiskSize | integer | no | The storage capacity of the disk per node. Unit: GB |
| VpcId | string | yes | The ID of the virtual private cloud (VPC) |
| VswitchId | string | yes | The ID of the vSwitch |

### Deletes a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/delete-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the cluster |
| DataCenterId | string | yes | The ID of the data center of the backup cluster |

### Deletes a cluster by ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/delete-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Deletes a cluster data center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/delete-data-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The cluster data center ID |

### Deletes nodetool execution records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/delete-node-tool-execution-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| JobId | string | yes | The job ID |
| DataCenterId | string | yes | The data center ID of the cluster |

### Queries the list of accounts for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the instance to which the account belongs |

### Retrieves the summary information of a backup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the backup cluster |
| DataCenterId | string | yes | The ID of the data center for the backup cluster |
| BackupId | string | yes | The ID of the backup |
| BackupType | string | yes | The backup type. Valid values: full: Full backup. Incremental: Incremental backup |

### Queries the details of a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the backup cluster |
| DataCenterId | string | yes | The ID of the data center for the backup cluster |

### Queries a list of backup plans
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-backup-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the backup cluster |

### Queries the backups of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the backup cluster |
| DataCenterId | string | yes | The data center ID of the backup cluster |
| BackupType | string | yes | The backup type. Valid values: full: Full backup. Incremental: Incremental backup |

### Queries the details of a Cassandra instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries dashboard data by calling DescribeClusterDashboard
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-cluster-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries the running status of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-cluster-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries information about all clusters in a specified region by calling DescribeClusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | no | The region ID, such as ap-southeast-1 |
| PageNumber | integer | no | The page number. Valid values: greater than 0 and not exceeding the maximum value of Integer. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| ClusterName | string | no | The cluster name |
| ResourceGroupId | string | no | The resource group ID. You can view available resource groups in the Resource Group console |
| Tag | string | no | The list of tags (JSON-encoded) |

### Calls DescribeContactPoints to obtain the database connection information of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-contact-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Retrieves the details of a specific data center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-data-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID. You can call the DescribeDataCenters operation to obtain the data center ID |

### Queries data center information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-data-centers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries the list of deleted clusters by calling DescribeDeletedClusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-deleted-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query available region IDs |
| PageNumber | integer | no | The page number. Valid values: greater than 0 and does not exceed the maximum value of Integer. Default value: 1 |
| PageSize | integer | no | The number of rows per page in a paged query |

### Queries instance specifications, such as CPU and memory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-instance-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| InstanceType | string | no | The name of the instance type. Valid values: cassandra.c.large: 2 vCPUs and 4 GB of memory cassandra.c.xlarge: 4 vCPUs and 8 GB of memory… |

### Retrieves the whitelist information of a cluster by cluster ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries the whitelist groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-ip-whitelist-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries the paginated nodetool execution records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-node-tool-execution-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the Cassandra cluster |
| PageNumber | integer | no | The page number. Valid values: greater than 0 and less than or equal to the maximum value of the Integer type Default value: 1 |
| PageSize | integer | no | The number of entries per page |

### Retrieves the details of a single command execution, including the execution result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-node-tool-execution-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DcId | string | yes | The data center ID. You can obtain the data center ID by calling DescribeDataCenters |
| JobId | string | yes | The ID of the execution job. You can obtain the job ID by calling DescribeNodeToolExecutionHistories |

### Queries the parameter modification history
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-parameter-modification-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| PageNumber | integer | no | The page number of the parameter modification history list. Valid values: an integer greater than 0 and up to the maximum value of the… |
| PageSize | integer | no | The number of entries per page in the parameter modification history list |

### Invokes DescribeParameters to query all parameters in the query parameter Settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| PageNumber | integer | no | The page number. Valid values: an integer greater than 0 and up to the maximum value of the Integer type. Default value: 1 |
| PageSize | integer | no | The number of entries per page to set in Settings for paging during a paged query. Default value: 10 |

### Queries the available regions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese. This is the default value. en-US: English. ja: Japanese |

### Queries security groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/describe-security-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Executes a nodetool command on a specified data center (DC)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/execute-node-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Command | string | yes | The command that follows nodetool |
| Arguments | string | no | The arguments that follow the nodetool command |
| DataCenterId | string | yes | The ID of the data center in the cluster |
| ExecuteNodes | string | no | The details of the nodes on which the command is executed |

### Calls GetCmsUrl to redirect to the CloudMonitor console
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/get-cms-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Queries a list of tags by resource ID or tag. You can query tags by key, or by both key and value
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | yes | The region ID |
| NextToken | string | no | The next token. If the number of results exceeds the limit, this token is returned to query the next page |
| ResourceId | string | no | The ID of the Nth resource, which is the cluster ID in this context. You can query multiple resources at a time by specifying parameters… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Retrieves all tags in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID |

### Modifies the password of a database account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The instance ID |
| Account | string | yes | The username |
| Password | string | yes | The account password. The password must be 8 to 32 characters in length and contain at least three of the following character types:… |

### Calls ModifyBackupPlan to modify a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the backup cluster |
| DataCenterId | string | yes | The ID of the cluster data center |
| BackupTime | string | no | The time when the backup starts each day. The time is in UTC and indicated by the Z suffix |
| BackupPeriod | string | no | The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
| RetentionPeriod | integer | no | The number of days for which the backup plan is retained |
| Active | string | no | Specifies whether the backup plan is active |

### Modifies the name of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| ClusterName | string | no | The cluster name |
| ConfirmProductOffline | string | no | The ConfirmProductOffline |

### Modifies the name of a data center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-data-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID |
| DataCenterName | string | no | The new name of the data center |

### Modifies the start time of the O&M window for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-instance-maintain-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the cluster for which you want to modify the O&M window |
| MaintainStartTime | string | yes | The start time of the O&M window for the instance. The time is in the HH:mm format |
| MaintainEndTime | string | yes | The end time of the O&M window for the instance. The time is in the HH:mm format |

### Modifies the instance type of a cluster by calling ModifyInstanceType
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-instance-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID of the cluster |
| InstanceType | string | yes | The instance type of the cluster. Examples of valid values: cassandra.c.large: 2 vCPUs, 4 GB memory cassandra.c.xlarge: 4 vCPUs, 8 GB… |

### Modifies the network access whitelist of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| IpList | string | yes | The list of IP addresses |

### Modifies the IP whitelist group of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-ip-whitelist-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| IpList | string | no | The IP whitelist |
| GroupName | string | yes | The name of the whitelist group |
| IpVersion | integer | yes | The IP version. Valid values: ipV4 and ipV6 |

### Updates a parameter in the parameter settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-parameter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Name | string | yes | The parameter name |
| Value | string | yes | The parameter value |

### Modifies security groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/modify-security-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| SecurityGroupIds | string | yes | The IDs of the associated security groups. Separate multiple IDs with commas. You can specify up to three IDs |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| NewResourceGroupId | string | yes | The ID of the new resource group. You can view available resource groups in the Resource Group console |

### Purges a deleted cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/purge-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the deleted cluster |

### Restarts a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/reboot-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The ID of the cluster to be restarted |
| DataCenterId | string | yes | The data center ID |

### Invokes ReleasePublicContactPoints to release public network connection endpoints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/release-public-contact-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID |

### Expands a disk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/resize-disk-size` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID of the cluster |
| DiskSize | integer | yes | The new size of the disk, in GB |

### Calls ResizeNodeCount to scale out the nodes of a data center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/resize-node-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DataCenterId | string | yes | The data center ID |
| NodeCount | integer | yes | The number of nodes in the data center |

### Calls the TagResources operation to add tags to instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceId | string | yes | The Nth resource ID, which is the cluster ID. If you have multiple resource IDs, you can pass parameters such as ResourceId.2 and… |
| Tag | string | yes | The list of tags (JSON-encoded) |

### Removes tags from resources. This operation is the counterpart to the TagResources operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/un-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| RegionId | string | yes | The region ID |
| All | string | no | Specifies whether to remove all tags. If TagKey is specified, only the tags with the specified keys are removed. Valid values: true and… |
| ResourceId | string | yes | The ID of the Nth resource from which you want to remove tags. In this context, the resource is a cluster. To specify multiple resources,… |
| TagKey | string | no | The key of the Nth tag that you want to remove. To specify multiple tag keys, use parameter names such as TagKey.2 and TagKey.3. N must be… |

### Upgrades the minor version of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/upgrade-cluster-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cassandra.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-cassandra/allocate-public-contact-points" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

### Is the Alibaba Cloud ApsaraDB for Cassandra 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 Cassandra itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraDB for Cassandra 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-cassandra.

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