CLI命令参考
集群管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询集群详情 | hcloud DWS ListClusterDetails | 查询集群详情。 | |
| 删除集群 | hcloud DWS DeleteCluster | 删除集群（旧接口）。集群删除后将释放此集群的所有资源，包括客户数据。为了安全起见，请在删除集群前为这个集群创建快照。 | |
| 重置密码 | hcloud DWS ResetPassword | 重置集群管理员密码。 | |
| 重启集群 | hcloud DWS RestartCluster | 重启集群。 | |
| 创建集群 | hcloud DWS CreateCluster | 该接口用于创建集群。建议使用新的v2接口，此接口仅保证现有功能，新功能新特性不再新增。 | |
| 查询集群列表 | hcloud DWS ListClusters | 查询集群列表。 | |
| 查询规格信息 | hcloud DWS ListNodeTypes | 该接口用于查询所有DWS服务支持的规格信息。 | |
| 创建集群前检查 | hcloud DWS CheckCluster | 创建集群前预检查，提前识别子网不足、配额不足等问题，避免发起创建集群请求后创建失败。 | |
| 查询专属分布式存储池列表 | hcloud DWS ListDssPools | 获取专属分布式存储池列表，只包括用户开通的SSD专属资源池信息。 | |
| 主备恢复 | hcloud DWS SwitchOverCluster | 当集群状态为“非均衡”时会出现某些节点主实例增多，从而负载压力较大。这种情况下集群状态是正常的，但整体性能要低于均衡状态。可进行集群主备恢复操作将集群状态切换为“可用”状态。 | |
| 解除只读 | hcloud DWS CancelReadonlyCluster | 当集群进入只读状态时，无法进行数据库相关操作，用户可以在管理控制台解除集群的只读状态。触发只读状态可能是由于磁盘使用率过高，因此需要对集群数据进行清理或扩容。 | |
| 修改集群安全组 | hcloud DWS ChangeSecurityGroup | 该接口用于修改集群安全组。 | |
| 查询集群规格详情 | hcloud DWS ShowClusterFlavor | 查询集群使用的规格详情。 | |
| 查询集群列表V2 | hcloud DWS ShowClusters | 该接口用于查询并显示集群列表。 | |
| 创建集群V2 | hcloud DWS CreateClusterV2 | 该接口用于创建集群。 | |
| 删除DWS集群 | hcloud DWS DeleteDwsCluster | 删除集群v2接口。集群删除后将释放此集群的所有资源，包括客户数据。为了安全起见，请在删除集群前为这个集群创建快照。 | |
| 修改集群描述信息 | hcloud DWS SaveClusterDescriptionInfo | 修改集群描述信息。 | |
| 查询单个实例 | hcloud DWS ShowInstance | 查询单个实例信息。 | |
| 启动集群 | hcloud DWS StartCluster | 启动集群。 | |
| 停止集群 | hcloud DWS StopCluster | 停止集群。 | |
| 查询集群拓扑ring环节点信息 | hcloud DWS ListTopoRings | 查询集群拓扑ring环节点信息。 | |
| 查询资源统计 | hcloud DWS ShowResourceStatistics | 该接口用于查询资源统计。 | |
| 修改集群时区 | hcloud DWS ModifyClusterTimezone | 修改集群时区。该操作会将操作系统及数据库的时区都进行修改。 | |
| 查询集群企业项目信息 | hcloud DWS ListTagsForResource | 查询指定集群的企业项目信息。 | |
| 查询磁盘使用情况 | hcloud DWS ShowClusterVolume | 查询租户侧节点磁盘使用情况信息。 | |
| 修改集群名称 | hcloud DWS ModifyClusterName | 修改集群名称。 |
快照管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建快照 | hcloud DWS CreateSnapshot | 该接口用于为指定集群创建快照。 | |
| 查询快照列表 | hcloud DWS ListSnapshots | 该接口用于查询快照列表。 | |
| 恢复集群 | hcloud DWS RestoreCluster | 该接口用于使用快照恢复集群。 | |
| 快照统计信息 | hcloud DWS ListSnapshotStatistics | 快照统计信息。 | |
| 复制快照 | hcloud DWS CopySnapshot | 该接口用于复制一个自动快照。 | |
| 查询集群快照列表 | hcloud DWS ListClusterSnapshots | 该接口用于查询集群快照列表。 | |
| 删除快照策略 | hcloud DWS DeleteSnapshotPolicy | 该接口用于删除一个快照策略。 | |
| 添加快照策略 | hcloud DWS CreateSnapshotPolicy | 该接口用于设置快照策略。 | |
| 查询快照策略 | hcloud DWS ListSnapshotPolicy | 查询快照策略。 | |
| 查询快照详情 | hcloud DWS ListSnapshotDetails | 该接口用于使用快照ID查询快照详情。 | |
| 删除快照 | hcloud DWS DeleteSnapshot | 该接口用于删除一个指定手动快照。 | |
| 用户恢复表名检测 | hcloud DWS CheckTableRestore | 该接口用于用户恢复表名检测。 | |
| 恢复表 | hcloud DWS RestoreTable | 该接口用于恢复表。 | |
| 根据快照ID查询规格信息 | hcloud DWS ListSnapshotFlavorInfo | 根据快照ID查询规格信息。支持用来查询某个快照的规格信息，或者快照可恢复到的目标规格信息。 |
节点变更
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 扩容集群 | hcloud DWS ResizeCluster | 扩容集群，亦可用于添加空闲节点。默认情况下：表示执行扩容操作。 | |
| 集群缩容 | hcloud DWS ShrinkCluster | 该接口用于缩容集群。 | |
| 查询集群CN节点 | hcloud DWS ListClusterCn | 查询集群的CN节点列表。 | |
| 批量增加CN节点 | hcloud DWS BatchCreateClusterCn | 当用户集群创建后，实际需要的CN数量会随着业务需求而发生变化，因此管理CN节点功能的实现使用户可以根据实际需求动态调整集群CN数量。 | |
| 批量删除CN节点 | hcloud DWS BatchDeleteClusterCn | 当用户集群创建后，实际需要的CN数量会随着业务需求而发生变化，因此管理CN节点功能的实现使用户可以根据实际需求动态调整集群CN数量。 | |
| 查询合适的缩容数 | hcloud DWS ListClusterScaleInNumbers | 查询合适的缩容数。 | |
| 下发重分布 | hcloud DWS ExecuteRedistributionCluster | 该接口用于集群扩容后将老节点数据均匀分布到新扩节点的数据重分布操作，数据“重分布”后将大大提升业务响应速率。 | |
| 查询重分布详情 | hcloud DWS ShowClusterRedistribution | 该接口用于查看当前集群的重分布模式、重分布进度、数据表重分布详情等监控信息。 | |
| 磁盘扩容 | hcloud DWS ExpandInstanceStorage | 随着客户业务的发展，磁盘空间往往最先出现资源瓶颈，在其他资源尚且充足的情况下，通过磁盘扩容可快速缓解存储资源瓶颈现象，操作过程中无需暂停业务，并且不会造成CPU、内存等资源浪费。 | |
| 从空闲节点扩容 | hcloud DWS ResizeClusterWithExistedNodes | 从空闲节点扩容。 | |
| 查询节点列表 | hcloud DWS ListClusterNodes | 查询节点列表。 | |
| 恢复重分布 | hcloud DWS RestoreRedistribution | 恢复暂停状态下的重分布操作，仅支持DWS2.0集群。 | |
| 暂停重分布 | hcloud DWS StopRedistribution | 该接口用于暂停运行状态下的重分布操作，重分布暂停状态可设置重分布优先级，修改重分布并发数等操作。 | |
| 删除空闲节点 | hcloud DWS DeleteClusterNodes | 删除空闲节点。 | |
| 更新重分布配置 | hcloud DWS UpdateRedistributionConfigurations | 更新重分布配置。 | |
| 更新重分布表优先级 | hcloud DWS SetRedistributionPriority | 更新重分布表优先级。 | |
| 集群扩容前检查 | hcloud DWS CheckGrowCluster | 集群扩容前检查，提前识别子网不足、权限不足等问题导致的扩容失败。 | |
| 集群缩容前检查 | hcloud DWS CheckClusterShrink | 缩容前检查，确保缩容前、缩容后均满足正常操作要求。 | |
| 获取待重分布表所属模式信息 | hcloud DWS ListRedistributionSchema | 获取待重分布表所属模式信息。 | |
| 查询支持变更的目标规格列表 | hcloud DWS ListTargetFlavors | 查询支持变更的目标规格列表。接口返回的规格列表最多为20条。 | |
| 执行规格变更 | hcloud DWS ExecuteFlavorChange | 执行规格变更。 | |
| 查询磁盘扩容范围 | hcloud DWS ShowClusterStorageExpandRange | 此接口可用于查看磁盘扩容操作时支持的扩容范围。 | |
| 集群扩容前准备 | hcloud DWS ResizePreparation | 下发扩容配置文件，完成扩容准备工作。 | |
| 获取扩容准备信息 | hcloud DWS ShowResizePreparation | 获取扩容准备信息。 |
配额管理
升级管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 修改运维时间窗 | hcloud DWS UpdateMaintenanceWindow | 您可以根据业务需求，设置可维护时间段。建议将可维护时间段设置在业务低峰期，避免业务在维护过程中异常中断。 | |
| 下发集群升级相关操作 | hcloud DWS ExecuteClusterUpgradeAction | 下发集群升级相关操作。 | |
| 获取集群可升级的目标版本 | hcloud DWS ListUpdatableVersion | 获取集群可升级的目标版本。 | |
| 获取集群升级记录 | hcloud DWS ListUpdateRecord | 通过此接口获取当前集群升级记录。 |
参数配置
资源管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 打开或关闭资源管理功能 | hcloud DWS CreateClusterWorkload | 打开或关闭资源管理功能，新集群默认是打开状态。 | |
| 查询资源管理开关状态 | hcloud DWS ListClusterWorkload | 查询资源管理开关状态。 | |
| 查询资源管理计划列表 | hcloud DWS ListWorkloadPlans | 查询集群中所有资源管理计划。 | |
| 添加资源管理计划 | hcloud DWS CreateWorkloadPlan | 添加资源管理计划。 | |
| 查询资源池 | hcloud DWS ListWorkloadQueue | 查询资源池。 | |
| 添加资源池 | hcloud DWS AddWorkloadQueue | 添加资源池。 | |
| 删除资源池 | hcloud DWS DeleteWorkloadQueue | 该接口用于删除资源池。 | |
| 停止资源管理计划 | hcloud DWS StopWorkloadPlan | 停止资源管理计划。 | |
| 查询某个资源管理计划详细信息 | hcloud DWS ShowWorkloadPlan | 查询某个资源管理计划详细信息。 | |
| 删除资源管理计划 | hcloud DWS DeleteWorkloadPlan | 删除资源管理计划。 | |
| 启动资源管理计划 | hcloud DWS StartWorkloadPlan | 启动资源管理计划。 | |
| 获得资源池的绑定用户列表 | hcloud DWS ListWorkloadQueueUsers | 获得资源池的绑定用户列表。 | |
| 获得资源池详细信息 | hcloud DWS ShowWorkloadQueue | 获得资源池详细信息。 | |
| 更新资源池基础信息 | hcloud DWS UpdateQueueBaseInfo | 更新资源池基础信息。 | |
| 查询资源管理计划阶段详细信息 | hcloud DWS ShowWorkloadPlanStage | 查询资源管理计划阶段详细信息。 | |
| 删除资源管理计划阶段 | hcloud DWS DeleteWorkloadPlanStage | 删除资源管理计划阶段。 | |
| 修改资源管理计划阶段 | hcloud DWS UpdateWorkloadPlanStage | 修改资源管理计划阶段。 | |
| 查看计划执行日志 | hcloud DWS ListPlanExecLogs | 查看计划执行日志。 | |
| 删除资源池的绑定用户 | hcloud DWS DeleteQueueUserList | 删除资源池的绑定用户。 | |
| 切换资源管理计划阶段 | hcloud DWS SwitchPlanStage | 切换资源管理计划阶段。 | |
| 添加资源池的绑定用户 | hcloud DWS AddQueueUserList | 添加资源池的绑定用户。 | |
| 更新资源池资源配置信息 | hcloud DWS UpdateQueueResources | 更新资源池资源配置信息。 | |
| 查询集群模式空间信息 | hcloud DWS ListSchemas | 查询集群模式空间信息。 | |
| 更新模式空间限额 | hcloud DWS UpdateSchemas | 更新模式空间限额。 | |
| 添加资源管理计划阶段 | hcloud DWS AddWorkloadPlanStage | 添加资源管理计划阶段。 | |
| 查询当前集群的异常规则列表 | hcloud DWS ListWorkloadRules | 查询当前集群的异常规则列表。 | |
| 添加异常规则 | hcloud DWS AddWorkloadRule | 添加异常规则。 | |
| 删除异常规则 | hcloud DWS DeleteWorkloadRule | 删除异常规则。 | |
| 更新异常规则 | hcloud DWS UpdateWorkloadRule | 更新异常规则。 |
容灾管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询容灾列表 | hcloud DWS ListDisasterRecover | 该接口用于查询容灾列表。 | |
| 创建容灾 | hcloud DWS CreateDisasterRecovery | 该接口用于创建集群间容灾。 | |
| 删除容灾 | hcloud DWS DeleteDisasterRecovery | 该接口用于删除容灾操作。 | |
| 查询容灾详情 | hcloud DWS ShowDisasterDetail | 该接口用于查询单个容灾详情。 | |
| 更新容灾配置 | hcloud DWS UpdateDisasterInfo | 该接口用于更新容灾配置操作。 | |
| 启动容灾 | hcloud DWS StartDisasterRecovery | 该接口用于启动容灾操作。 | |
| 停止容灾 | hcloud DWS PauseDisasterRecovery | 该接口用于停止容灾操作。 | |
| 灾备切换 | hcloud DWS SwitchoverDisasterRecovery | 该接口用于容灾进行灾备切换操作。 | |
| 容灾异常切换 | hcloud DWS SwitchFailoverDisaster | 该接口用于容灾异常场景下进行主备集群切换操作。 | |
| 恢复容灾 | hcloud DWS RestoreDisaster | 该接口用于主备集群进行异常切换，备集群恢复可用状态后进行的容灾恢复操作。 | |
| 查询可用容灾集群列表 | hcloud DWS ListAvailableDisasterClusters | 该接口用于查询可用的容灾集群列表。 | |
| 检查容灾名称 | hcloud DWS CheckDisasterName | 该接口用于查询容灾名称是否可用。 | |
| 查询容灾进度详情 | hcloud DWS ShowDisasterProgress | 该接口用于查询容灾进度详情信息操作。 |
审计日志
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询日志记录 | hcloud DWS ListAuditLog | 查询审计日志记录。 |
数据源
连接管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取集群可绑定的ELB列表 | hcloud DWS ListElbs | 查询集群可以关联的ELB列表。 | |
| 集群绑定ELB | hcloud DWS AssociateElb | 集群绑定Elb接口。 | |
| 集群解绑ELB | hcloud DWS DisassociateElb | 集群解绑Elb接口。 | |
| 集群绑定EIP | hcloud DWS AssociateEip | 集群绑定Eip。 | |
| 集群解绑EIP | hcloud DWS DisassociateEip | 集群解绑Eip。 | |
| 申请域名 | hcloud DWS CreateClusterDns | 为指定集群申请域名。 | |
| 修改集群域名 | hcloud DWS UpdateClusterDns | 为指定集群修改域名。 | |
| 删除集群域名 | hcloud DWS DeleteClusterDns | 删除指定集群域名。 | |
| 查询连接信息 | hcloud DWS ListClusterEndpoints | 查询连接信息。包括公网域名、内网域名等。 |
主机监控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询主机概览 | hcloud DWS ListHostOverview | 查询主机概览。 | |
| 查询磁盘信息 | hcloud DWS ListHostDisk | 查询磁盘信息。 | |
| 获取网卡状态 | hcloud DWS ListHostNet | 获取网卡状态。 | |
| 查询历史监控数据 | hcloud DWS ListMonitorIndicatorData | 查询历史监控数据。 | |
| 查询性能监控指标 | hcloud DWS ListMonitorIndicators | 查询性能监控指标。 | |
| 查询SQL列表 | hcloud DWS ListQueries | 该接口用于查询实时SQL列表。 | |
| 查询表倾斜或脏页率信息 | hcloud DWS ListTablesStatistic | 该接口用于查询表倾斜或脏页率信息。 | |
| 查询SQL执行信息 | hcloud DWS ShowQueryDetail | 查询SQL执行信息。 | |
| 查询集群使用的指标列表 | hcloud DWS ListMetrics | 查询集群使用的指标列表。 | |
| 获取指定指标相关采集数据 | hcloud DWS ListMetricsData | 获取指定指标相关采集数据。 |
告警管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询告警配置 | hcloud DWS ListAlarmConfigs | 查询告警配置。 | |
| 查询告警详情列表 | hcloud DWS ListAlarmDetail | 查询告警详情列表。 | |
| 查询告警统计列表 | hcloud DWS ListAlarmStatistic | 查询告警统计。 | |
| 查询告警订阅列表 | hcloud DWS ListAlarmSubs | 查询订阅告警。 | |
| 创建告警订阅 | hcloud DWS CreateAlarmSub | 创建订阅告警。 | |
| 更新告警订阅 | hcloud DWS UpdateAlarmSub | 更新订阅的告警。 | |
| 删除告警订阅 | hcloud DWS DeleteAlarmSub | 删除订阅的告警。 |
事件管理
任务管理
标签管理
可用区
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询可用区列表 | hcloud DWS ListAvailabilityZones | 在创建实例时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。 |
数据库权限管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 修改数据库对象权限 | hcloud DWS UpdateDatabaseAuthority | 修改数据库对象权限。 | |
| 查询数据库对象权限 | hcloud DWS ShowDatabaseAuthority | 查询数据库对象权限。 | |
| 同步IAM用户到数据库 | hcloud DWS SyncIamUsers | 同步IAM用户到数据库。 | |
| 查询所有数据库用户/角色 | hcloud DWS ListDatabaseUsers | 查询所有数据库用户/角色。 | |
| 创建数据库用户/角色 | hcloud DWS CreateDatabaseUser | 创建数据库用户/角色。 | |
| 查询指定用户信息 | hcloud DWS ShowDatabaseUser | 查询指定用户信息。 | |
| 修改指定用户信息 | hcloud DWS UpdateDatabaseUserInfo | 修改指定用户信息。 | |
| 删除数据库用户 | hcloud DWS DeleteDatabaseUser | 删除数据库用户。 | |
| 执行运维用户操作 | hcloud DWS ExecuteDatabaseOmUserAction | 进行数据库运维账户操作。 | |
| 获得集群运维账户状态 | hcloud DWS ShowDatabaseOmUserStatus | 获得数据库运维账户状态。 | |
| 导出数据库用户/角色 | hcloud DWS ExportDatabaseUsers | 导出数据库用户/角色，接口返回的是输出流，xlsx文件。 | |
| 导出数据库用户/角色的权限 | hcloud DWS ExportUserAuthority | 导出数据库用户/角色的权限列表，接口返回的是输出流，xlsx文件。 | |
| 查询用户/角色拥有权限 | hcloud DWS ListDatabaseUserAuthorities | 查询用户/角色拥有权限。 | |
| 查询身份源同步记录 | hcloud DWS ListSyncRecords | 查询身份源同步记录。 | |
| 查询数据库对象 | hcloud DWS ListDatabaseObjects | 查询数据库对象。 |
逻辑集群管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询逻辑集群磁盘信息 | hcloud DWS ListLogicalClusterVolumes | 查询逻辑集群磁盘信息。 | |
| 重启逻辑集群 | hcloud DWS RestartLogicalCluster | 重启逻辑集群。 | |
| 删除逻辑集群 | hcloud DWS DeleteLogicalCluster | 删除逻辑集群。 | |
| 编辑逻辑集群 | hcloud DWS UpdateLogicalCluster | 编辑修改逻辑集群。接口根据提交的请求体判断当前操作是逻辑集群缩容或者扩容。 | |
| 删除逻辑集群定时增删计划 | hcloud DWS DeleteLogicalClusterPlan | 删除逻辑集群定时增删计划。 | |
| 编辑逻辑集群增删计划 | hcloud DWS UpdateLogicalClusterPlan | 编辑逻辑集群增删计划。 | |
| 启用逻辑集群定时增删计划 | hcloud DWS EnableLogicalClusterPlan | 启用逻辑集群定时增删计划。 | |
| 停用逻辑集群定时增删计划 | hcloud DWS DisableLogicalClusterPlan | 停用逻辑集群定时增删计划。 | |
| 查询逻辑集群定时增删计划 | hcloud DWS ListLogicalClusterPlans | 查询逻辑集群定时增删计划。定时增删计划业务支持最多保存20条数据，接口最大返回20条数据。 | |
| 添加逻辑集群定时增删计划 | hcloud DWS CreateLogicalClusterPlan | 添加逻辑集群定时增删计划。 | |
| 切换逻辑集群开关 | hcloud DWS EnableLogicalCluster | 切换逻辑集群开关，仅用于控制逻辑集群相关功能模块是否在页面展示。 | |
| 物理集群转换到逻辑集群 | hcloud DWS ConvertToLogicalCluster | 物理集群转换到逻辑集群。 | |
| 查询逻辑集群任务信息 | hcloud DWS ListLogicalClusterTasks | 查询逻辑集群任务信息。 | |
| 创建逻辑集群 | hcloud DWS CreateLogicalCluster | 使用弹性池的节点，创建逻辑集群，此接口已经不再演进，后续版本中可能会下线，新版本中此接口对应功能已经下线。 | |
| 查询逻辑集群列表 | hcloud DWS ListLogicalClusters | 查询逻辑集群列表。 | |
| 逻辑集群缩容 | hcloud DWS ShrinkLogicalCluster | 逻辑集群缩容，支持从逻辑集群中缩容、从弹性池中缩容。 | |
| 查询逻辑集群可用环节点信息 | hcloud DWS ListLogicalClusterRings | 查询逻辑集群可用环节点信息。 |
