API概览

本产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来。

实例管理

API	描述
CreateCluster	调用CreateCluster创建一个Cassandra实例。
CreateDataCenter	调用CreateDataCenter为集群添加数据中心。
DeleteCluster	调用DeleteCluster删除指定ID集群。
DescribeCluster	调用DescribeCluster查询Cassandra实例的详细信息。
DescribeClusters	调用DescribeClusters查询指定地域下的所有集群信息。
DescribeClusterStatus	调用DescribeClusterStatus查询集群的运行状态。
DescribeDeletedClusters	调用DescribeDeletedClusters查询已删除的集群列表。
DescribeInstanceType	调用DescribeInstanceType查询实例规格（cpu、mem）。
ModifyCluster	调用ModifyCluster修改集群名称。
ModifyInstanceMaintainTime	调用ModifyInstanceMaintainTime修改实例运维起始时间。
ModifyInstanceType	调用ModifyInstanceType修改实例规格类型。
PurgeCluster	调用PurgeCluster清除已被删除的集群。
RebootCluster	调用RebootCluster重启集群。
ResizeDiskSize	调用ResizeDiskSize扩容磁盘。
ResizeNodeCount	调用ResizeNodeCount扩容数据中心的节点。
UpgradeClusterVersion	调用UpgradeClusterVersion升级集群小版本。

安全管理

API	描述
ModifyIpWhitelist	调用ModifyIpWhitelist修改集群网络访问白名单。
DescribeIpWhitelist	调用DescribeIpWhitelist查询集群网络访问白名单。
DescribeIpWhitelistGroups	调用DescribeIpWhitelistGroups查询白名单分组列表。
ModifyIpWhitelistGroup	调用ModifyIpWhitelistGroup修改集群白名单组。
DescribeSecurityGroups	调用DescribeSecurityGroups查询安全组。
ModifySecurityGroups	调用ModifySecurityGroups修改安全组。

账号管理

API	描述
DescribeAccounts	调用DescribeAccounts查找指定ID实例的账户列表信息。
ModifyAccountPassword	调用ModifyAccountPassword修改账号密码。

可用区管理

API	描述
DescribeRegions	调用DescribeRegions查询可用地域。
DeleteDataCenter	调用DeleteDataCenter删除集群数据中心。
ModifyDataCenter	调用ModifyDataCenter修改数据中心名称。
DescribeDataCenters	调用DescribeDataCenters获取数据中心信息。

备份管理

API	描述
DescribeBackup	调用DescribeBackup获取备份概要信息。
DeleteBackupPlan	调用DeleteBackupPlan删除备份计划。
CreateBackupPlan	调用CreateBackupPlan创建备份计划。
DescribeBackupPlan	调用DescribeBackupPlan描述备份计划。
DescribeBackups	调用DescribeBackups获取集群备份列表。
ModifyBackupPlan	调用ModifyBackupPlan修改备份计划。
DescribeBackupPlans	调用DescribeBackupPlans查询备份计划列表。

连接点管理

API	描述
AllocatePublicContactPoints	调用AllocatePublicContactPoints分配公共联系点。
DescribeContactPoints	调用DescribeContactPoints获取集群数据库连接信息 。
ReleasePublicContactPoints	调用ReleasePublicContactPoints释放公网连接点。

Nodetool

API	描述
DescribeNodeToolExecutionHistories	分页获取nodetool执行记录。
ExecuteNodeTool	调用ExecuteNodeTool在指定dc执行nodetool命令。
DeleteNodeToolExecutionHistory	调用DeleteNodeToolExecutionHistory删除nodetool执行记录。

参数管理

API	描述
DescribeParameters	调用DescribeParameters查询参数设置中的所有参数。
ModifyParameter	调用ModifyParameter修改参数设置中的参数。
DescribeParameterModificationHistories	调用DescribeParameterModificationHistories查看参数修改历史。

仪表盘管理

API	描述
DescribeClusterDashboard	调用DescribeClusterDashboard查询仪表盘数据。

标签管理

API	描述
TagResources	调用TagResources接口为实例增加Tag标签。
UnTagResources	调用UnTagResources接口删除资源标签。对照TagResources创建接口。
ListTagResources	通过ResourceId或者Tag（Key查询、key和value同时查询）获取标签列表。
ListTags	根据region获取该region下所有Tag。