CLI命令参考
查询API版本
引擎版本和规格
实例管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建实例 | hcloud DDS CreateInstance | 创建文档数据库实例,包括集群实例、副本集实例、以及单节点实例。 | |
| 查询实例列表和详情 | hcloud DDS ListInstances | 根据指定条件查询实例列表和详情。 | |
| 重启实例 | hcloud DDS RestartInstance | 重启实例的数据库服务。 | |
| 删除实例 | hcloud DDS DeleteInstance | 删除数据库实例。 | |
| 修改实例备注 | hcloud DDS UpdateInstanceRemark | 修改实例备注。 | |
| 扩容实例存储容量 | hcloud DDS ResizeInstanceVolume | 扩容实例相关的存储容量大小。 | |
| 扩容集群实例的节点数量 | hcloud DDS AddShardingNode | 扩容指定集群实例的节点数量。 | |
| 变更实例规格 | hcloud DDS ResizeInstance | 变更实例的规格。 | |
| 切换实例的主备节点 | hcloud DDS SwitchoverReplicaSet | 切换实例下的主备节点 | |
| 切换SSL开关 | hcloud DDS SwitchSsl | 切换实例的SSL开关 | |
| 修改实例名称 | hcloud DDS UpdateInstanceName | 修改实例名称 | |
| 修改数据库端口 | hcloud DDS UpdateInstancePort | 修改数据库实例的端口。 | |
| 变更实例安全组 | hcloud DDS UpdateSecurityGroup | 变更实例关联的安全组 | |
| 绑定弹性公网IP | hcloud DDS AttachEip | 为实例下的节点绑定弹性公网IP。 | |
| 解绑弹性公网IP | hcloud DDS CancelEip | 解绑实例下节点已经绑定的弹性公网IP。 | |
| 绑定公网网关 | hcloud DDS BindPublicGateway | 为实例下的节点绑定公网网关。 | |
| 解绑公网网关 | hcloud DDS UnbindPublicGateway | 为实例下的节点解绑公网网关。 | |
| 修改实例内网地址 | hcloud DDS AttachInternalIp | 修改实例的内网地址 | |
| 创建集群的Shard/Config IP | hcloud DDS CreateIp | 创建集群的Shard/Config IP | |
| 副本集跨网段访问配置。 | hcloud DDS UpdateClientNetwork | 副本集跨网段访问配置。 | |
| 查询副本集跨网段访问配置 | hcloud DDS ShowClientNetwork | 查询副本集跨网段访问配置 | |
| 查询实例可迁移到的可用区 | hcloud DDS ListAz2Migrate | 查询实例可迁移到的可用区。 | |
| 实例可用区迁移 | hcloud DDS MigrateAz | 实例可用区迁移。 | |
| 实例新增只读节点 | hcloud DDS AddReadonlyNode | DDS副本集实例新增只读节点。 | |
| 删除只读节点 | hcloud DDS DeleteReadonlyNode | 当副本集添加了只读节点后,需要删除对应的只读节点需要调用此API。 | |
| 数据库补丁升级 | hcloud DDS UpgradeDatabaseVersion | 升级数据库补丁版本。 | |
| 开启/关闭秒级监控 | hcloud DDS SwitchSecondLevelMonitoring | 开启或关闭指定实例的秒级监控。 | |
| 查询秒级监控配置 | hcloud DDS ShowSecondLevelMonitoringStatus | 查询秒级监控配置。 | |
| 设置可维护时间段 | hcloud DDS ChangeOpsWindow | 修改用户允许启动某项对数据库实例运行有影响的任务的时间范围,例如操作系统升级和数据库软件版本升级的时间窗。 | |
| 设置实例回收站策略 | hcloud DDS SetRecyclePolicy | 设置实例回收站策略 | |
| 查询实例回收站策略 | hcloud DDS ShowRecyclePolicy | 查询实例回收站策略 | |
| 查询回收站实例列表 | hcloud DDS ListRecycleInstances | 查询回收站实例列表 | |
| 检查弱密码 | hcloud DDS CheckWeakPassword | 检查弱密码 | |
| 查询数据库补丁升级预估时长 | hcloud DDS ShowUpgradeDuration | 查询数据库补丁升级预估时长 | |
| 查询实例磁盘信息 | hcloud DDS ShowDiskUsage | 查询实例磁盘信息 | |
| 获取SSL证书下载地址 | hcloud DDS ListSslCertDownloadAddress | 获取SSL证书下载地址 | |
| 扩容副本集实例的节点数量 | hcloud DDS ExpandReplicasetNode | 扩容指定副本集实例的节点数量 | |
| 查询数据库复制集名称 | hcloud DDS ShowReplSetName | 查询数据库复制集名称 | |
| 修改数据库复制集名称 | hcloud DDS UpdateReplSetName | 修改数据库复制集名称 | |
| 设置磁盘自动扩容策略 | hcloud DDS SetAutoEnlargePolicies | 设置磁盘自动扩容策略。 | |
| 删除实例的节点 | hcloud DDS ShrinkInstanceNodes | 删除实例的节点。 | |
| 查询LTS日志配置信息 | hcloud DDS ListLtsConfigs | 查询LTS日志配置信息。 | |
| 关联LTS日志流 | hcloud DDS UpdateLtsConfig | 将实例日志与LTS日志流关联,后台将自动上传实例日志到关联的LTS日志流里。 | |
| 解除关联LTS日志流 | hcloud DDS DeleteLtsConfig | 将实例日志与LTS日志流解除关联,后台将取消上传实例日志到的LTS日志流里。 | |
| 查询磁盘自动扩容策略 | hcloud DDS ShowAutoEnlargePolicy | 查询磁盘自动扩容策略。 | |
| 批量数据库补丁升级 | hcloud DDS BatchUpgradeDatabaseVersion | 批量升级数据库补丁版本。 | |
| 删除mongos节点 | hcloud DDS DeleteMongosNode | 当集群实例需要缩减mongos节点时,需要调用此API。 | |
| 删除集群的Shard/Config IP | hcloud DDS DeleteIp | 删除集群的Shard/Config IP | |
| 删除分片 | hcloud DDS BatchDeleteShards | 删除分片 |
连接管理
备份与恢复
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 恢复到新实例 | hcloud DDS RestoreNewInstance | 根据备份恢复新实例。 | |
| 创建手动备份 | hcloud DDS CreateManualBackup | 创建数据库实例的手动备份。 | |
| 查询备份列表 | hcloud DDS ListBackups | 根据指定条件查询备份列表。 | |
| 删除手动备份 | hcloud DDS DeleteManualBackup | 删除数据库实例的手动备份。 | |
| 停止备份 | hcloud DDS StopBackup | 支持紧急情况下停止备份功能。 | |
| 设置自动备份策略 | hcloud DDS SetBackupPolicy | 设置自动备份策略。 | |
| 查询自动备份策略 | hcloud DDS ShowBackupPolicy | 查询自动备份策略。 | |
| 获取备份下载链接 | hcloud DDS ShowBackupDownloadLink | 获取备份下载链接。 | |
| 查询可恢复的时间段 | hcloud DDS ListRestoreTimes | 查询实例的可恢复时间段。 | |
| 获取可恢复的数据库列表 | hcloud DDS ListRestoreDatabases | 获取可恢复的数据库列表。 | |
| 获取可恢复的数据库集合列表 | hcloud DDS ListRestoreCollections | 获取可恢复的数据库集合列表。 | |
| 恢复到当前实例 | hcloud DDS RestoreInstance | 恢复到当前实例。 | |
| 库表级时间点恢复 | hcloud DDS RestoreInstanceFromCollection | 库表级时间点恢复。 | |
| 创建备份下载策略 | hcloud DDS SaveBackupDownloadPolicy | 创建备份下载策略。 | |
| 更新备份下载策略 | hcloud DDS UpdateBackupDownloadPolicy | 更新备份下载策略。 | |
| 查询备份下载策略 | hcloud DDS ListBackupDownloadPolicy | 查询备份下载策略。 | |
| 批量删除手动备份 | hcloud DDS BatchDeleteBackup | 批量删除数据库实例的手动备份。 |
获取日志信息
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 设置审计日志策略 | hcloud DDS SetAuditlogPolicy | 设置审计日志策略。 | |
| 查询审计日志策略 | hcloud DDS ShowAuditlogPolicy | 查询审计日志策略。 | |
| 获取审计日志列表 | hcloud DDS ListAuditlogs | 获取审计日志列表。 | |
| 删除审计日志 | hcloud DDS DeleteAuditLog | 删除审计日志 | |
| 获取审计日志下载链接 | hcloud DDS ListAuditlogLinks | 获取审计日志下载链接。 | |
| 查询数据库慢日志 | hcloud DDS ListSlowLogs | 查询数据库慢日志信息。 | |
| 查询数据库慢日志 | hcloud DDS ListLtsSlowLogs | 查询数据库慢日志信息,支持关键字、数据库表名等搜索功能。 | |
| 获取慢日志下载链接 | hcloud DDS DownloadSlowlog | 获取慢日志下载链接。 | |
| 查询数据库错误日志 | hcloud DDS ListErrorLogs | 查询数据库错误信息。 | |
| 获取错误日志下载链接 | hcloud DDS DownloadErrorlog | 获取错误日志下载链接。 | |
| 设置慢日志明文开关 | hcloud DDS SwitchSlowlogDesensitization | 设置实例的慢日志明文开关。 | |
| 查询慢日志明文开关 | hcloud DDS ShowSlowlogDesensitizationSwitch | 查询慢日志明文开关 | |
| 查询数据库错误日志 | hcloud DDS ListLtsErrorLogs | 查询数据库错误日志信息。 |
标签管理
管理数据库和用户
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建数据库用户 | hcloud DDS CreateDatabaseUser | 创建数据库用户。 | |
| 删除数据库用户 | hcloud DDS DeleteDatabaseUser | 删除数据库用户。 | |
| 创建数据库角色 | hcloud DDS CreateDatabaseRole | 创建数据库角色。 | |
| 删除数据库角色 | hcloud DDS DeleteDatabaseRole | 删除数据库角色。 | |
| 查询数据库用户列表 | hcloud DDS ListDatabaseUsers | 查询数据库用户列表。 | |
| 查询数据库角色列表 | hcloud DDS ListDatabaseRoles | 查询数据库角色列表。 | |
| 修改数据库用户密码 | hcloud DDS ResetPassword | 修改数据库用户密码。 | |
| 检查数据库密码 | hcloud DDS CheckPassword | 检查数据库密码。 | |
| 查询集群均衡设置 | hcloud DDS ShowShardingBalancer | 查询集群均衡设置。 | |
| 设置集群均衡开关 | hcloud DDS SetBalancerSwitch | 设置集群均衡开关。 | |
| 设置集群均衡活动时间窗 | hcloud DDS SetBalancerWindow | 设置集群均衡活动时间窗。 | |
| 查询数据库列表 | hcloud DDS ListDatabases | 查询数据库列表。 |
参数配置
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取参数模板列表 | hcloud DDS ListConfigurations | 获取参数模板列表,包括DDS数据库的所有默认参数模板和用户创建的参数模板。 | |
| 创建参数模板 | hcloud DDS CreateConfiguration | 创建参数模板。 | |
| 删除参数模板 | hcloud DDS DeleteConfiguration | 删除指定参数模板。 | |
| 获取参数模板的详情 | hcloud DDS ShowConfigurationParameter | 获取指定参数模板的参数信息。 | |
| 修改参数模板 | hcloud DDS UpdateConfigurationParameter | 修改指定参数模板的参数信息,包括名称、描述、指定参数的值。 | |
| 应用参数模板 | hcloud DDS SwitchConfiguration | 指定实例变更参数模板。 | |
| 获取指定实例的参数信息 | hcloud DDS ShowEntityConfiguration | 获取指定实例的参数信息。 | |
| 修改指定实例的参数 | hcloud DDS UpdateEntityConfiguration | 修改指定实例的参数,可以是实例,组,节点的参数模板。 | |
| 校验参数模板名称是否存在 | hcloud DDS ValidateConfigurationName | 校验参数模板名称是否存在。 | |
| 查询实例参数的修改历史 | hcloud DDS ShowInstanceConfigurationModifyHistory | 查询实例参数的修改历史。 | |
| 查询可应用的实例 | hcloud DDS ListAppliedInstances | 查询指定参数模板可被应用的实例。 | |
| 查询参数模板被应用历史 | hcloud DDS ShowConfigurationAppliedHistory | 查询参数模板应用历史 | |
| 查询参数模板修改历史 | hcloud DDS ShowConfigurationModifyHistory | 查询参数模板修改历史。 | |
| 参数模板比较 | hcloud DDS CompareConfiguration | 比较两个参数模板之间的差异。 | |
| 复制参数模板 | hcloud DDS CopyConfiguration | 复制参数模板。 | |
| 重置参数模板 | hcloud DDS ResetConfiguration | 重置参数模板。 |
配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询配额 | hcloud DDS ShowQuotas | 查询单租户在DDS服务下的资源配额,包括单节点实例配额、副本集实例配额、集群实例配额等。 |
任务管理
数据库运维
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取killOp规则列表 | hcloud DDS ShowKillOpRuleRuleList | 获取killOp规则列表。 | |
| 启用/禁用killOp规则 | hcloud DDS UpdateKillOpRule | 启用/禁用killOp规则。 | |
| 创建killOp规则 | hcloud DDS CreateKillOpRule | 创建killOp规则。 | |
| 删除killOp规则 | hcloud DDS DeleteKillOpRuleList | 删除killOp规则。 | |
| 强制备节点升主 | hcloud DDS SwitchInstancePrimary | 支持副本集、shard和config备节点强制升主。 |