CLI命令参考

查询当前支持的API版本信息列表

hcloud GaussDBforNoSQL ListApiVersion

查询当前支持的API版本信息列表。

去调试

查询指定API版本信息

hcloud GaussDBforNoSQL ShowApiVersion

查询指定API版本信息。

去调试

查询指定实例类型的数据库版本信息

hcloud GaussDBforNoSQL ListDatastores

查询指定实例类型的数据库版本信息。

去调试

查询指定条件下的所有实例规格信息

hcloud GaussDBforNoSQL ListFlavors

查询指定条件下的所有实例规格信息。

去调试

查询数据库规格

hcloud GaussDBforNoSQL ListFlavorInfos

查询指定条件下的实例规格信息。

去调试

查询专属资源列表

hcloud GaussDBforNoSQL ListDedicatedResources

查询专属资源列表。

去调试

创建实例

hcloud GaussDBforNoSQL CreateInstance

创建数据库实例。

去调试

查询实例列表和详情

hcloud GaussDBforNoSQL ListInstances

根据指定条件查询数据库实例列表和详情。

去调试

删除实例

hcloud GaussDBforNoSQL DeleteInstance

删除数据库实例。

去调试

扩容实例存储容量

hcloud GaussDBforNoSQL ResizeInstanceVolume

扩容实例的存储容量大小。

去调试

扩容指定集群实例的节点数量

hcloud GaussDBforNoSQL ExpandInstanceNode

扩容指定集群实例的节点数量。

去调试

缩容指定集群实例的节点数量

hcloud GaussDBforNoSQL ShrinkInstanceNode

缩容指定集群实例的节点数量。

去调试

查询实例可变更规格

hcloud GaussDBforNoSQL ListAvailableFlavorInfos

查询实例可变更规格。

去调试

变更实例规格

hcloud GaussDBforNoSQL ResizeInstance

变更实例的规格。

去调试

修改实例的管理员密码

hcloud GaussDBforNoSQL ResetPassword

修改实例的管理员密码。

去调试

修改实例名称

hcloud GaussDBforNoSQL UpdateInstanceName

修改实例名称

去调试

变更实例安全组

hcloud GaussDBforNoSQL UpdateSecurityGroup

变更实例关联的安全组

去调试

数据库补丁升级

hcloud GaussDBforNoSQL UpgradeDbVersion

升级数据库补丁版本

去调试

批量数据库补丁升级

hcloud GaussDBforNoSQL BatchUpgradeDatabaseVersion

批量升级数据库补丁版本。

去调试

‘创建冷数据存储’

hcloud GaussDBforNoSQL CreateColdVolume

‘创建冷数据存储’

去调试

扩容冷数据存储

hcloud GaussDBforNoSQL ResizeColdVolume

扩容冷数据存储。

去调试

绑定/解绑弹性公网IP

hcloud GaussDBforNoSQL ModifyPublicIp

实例下的节点绑定弹性公网IP/解绑弹性公网IP

去调试

切换实例SSL开关

hcloud GaussDBforNoSQL SwitchSsl

切换实例SSL开关。

去调试

设置磁盘自动扩容策略

hcloud GaussDBforNoSQL SetAutoEnlargePolicy

设置磁盘自动扩容策略。

去调试

重启实例或节点

hcloud GaussDBforNoSQL RestartInstance

重启实例或节点的数据库服务。

去调试

变更实例存储容量

hcloud GaussDBforNoSQL ModifyVolume

变更实例的存储容量大小

去调试

判断弱密码

hcloud GaussDBforNoSQL CheckWeekPassword

判断弱密码。

去调试

修改数据库端口

hcloud GaussDBforNoSQL ModifyPort

修改数据库实例的端口。

去调试

修改副本集跨网段访问配置

hcloud GaussDBforNoSQL UpdateClientNetwork

修改副本集跨网段访问配置

去调试

删除扩容失败的节点

hcloud GaussDBforNoSQL DeleteEnlargeFailNode

删除扩容失败的节点

去调试

查询创建实例或扩容节点时需要的IP数量

hcloud GaussDBforNoSQL ShowIpNumRequirement

查询创建实例或扩容节点时需要的IP数量

去调试

查询磁盘自动扩容策略

hcloud GaussDBforNoSQL ShowAutoEnlargePolicy

查询磁盘自动扩容策略

去调试

查询高危命令

hcloud GaussDBforNoSQL ShowHighRiskCommands

查询Redis的高危命令

去调试

修改高危命令

hcloud GaussDBforNoSQL UpdateHighRiskCommands

批量修改高危命令

去调试

支持节点的开关机

hcloud GaussDBforNoSQL OfflineNodes

当底层故障导致节点无法正常工作时，可以对该节点执行关机操作，关机后会由其他节点接管业务。

去调试

查询Redis实例的大key

hcloud GaussDBforNoSQL ShowRedisBigKeys

支持查询Redis实例的大key。value长度大于bigkeys-string-threshold参数的string类型的key或者元素数大于bigkeys-composite-threshold参数的hash/list/zset/set/stream类型key，会被判断为大key。

去调试

查询Redis实例的热key

hcloud GaussDBforNoSQL ShowRedisHotKeys

支持查询Redis实例的热key。

去调试

获取GeminiDB Redis的免密配置

hcloud GaussDBforNoSQL ShowPasswordlessConfig

获取GeminiDB Redis的免密配置。

去调试

支持修改GeminiDB Redis的免密配置

hcloud GaussDBforNoSQL UpdatePasswordlessConfig

支持修改GeminiDB Redis的免密配置。

去调试

查询节点自动扩容策略

hcloud GaussDBforNoSQL ShowAutoNodeExpansionPolicy

查询节点自动扩容策略。

去调试

设置节点自动扩容策略

hcloud GaussDBforNoSQL ModifyAutoNodeExpansionPolicy

设置节点自动扩容策略。

去调试

获取节点会话列表

hcloud GaussDBforNoSQL ListInstancesSession

获取节点会话列表。

去调试

删除Redis禁用命令

hcloud GaussDBforNoSQL DeleteRedisDisabledCommands

删除Redis禁用命令。

去调试

设置Redis禁用命令

hcloud GaussDBforNoSQL SaveRedisDisabledCommands

设置Redis禁用命令。

去调试

查询Redis禁用命令

hcloud GaussDBforNoSQL ShowRedisDisabledCommands

查询Redis禁用命令。

去调试

解除内存加速映射

hcloud GaussDBforNoSQL DeleteDbCacheMapping

解除指定内存加速映射。

去调试

创建内存加速映射

hcloud GaussDBforNoSQL CreateDbCacheMapping

创建内存加速映射。

去调试

创建内存加速规则

hcloud GaussDBforNoSQL CreateDbCacheRule

创建内存加速规则。

去调试

修改内存加速规则

hcloud GaussDBforNoSQL UpdateDbCacheRule

修改指定内存加速规则。

去调试

删除内存加速规则

hcloud GaussDBforNoSQL DeleteDbCacheRule

删除内存加速规则。

去调试

查询内存加速映射列表和详情

hcloud GaussDBforNoSQL ListDbCacheMappings

根据指定条件查询内存加速映射关系列表和详情。

去调试

查询内存加速规则列表和详情

hcloud GaussDBforNoSQL ListDbCacheRules

查询内存加速规则列表和详情。

去调试

开启/关闭秒级监控

hcloud GaussDBforNoSQL SwitchSecondLevelMonitoring

开启或关闭指定实例的5秒级监控。

去调试

查询秒级监控配置

hcloud GaussDBforNoSQL ShowSecondLevelMonitoringStatus

查询秒级监控配置。

去调试

开启/关闭实例数据导出

hcloud GaussDBforNoSQL SetInstanceDataDump

开启/关闭实例数据导出。

去调试

查询实例可维护时间段

hcloud GaussDBforNoSQL ListInstanceMaintenanceWindow

查询实例可维护时间段。

去调试

设置实例可维护时间段

hcloud GaussDBforNoSQL ModifyInstanceMaintenanceWindow

设置指定实例可维护时间段。

去调试

查询定时任务列表

hcloud GaussDBforNoSQL ListNosqlTaskList

根据指定条件查询定时任务列表。

去调试

取消定时任务

hcloud GaussDBforNoSQL CancelInstanceScheduleWindow

取消定时任务

去调试

Redis主备切换

hcloud GaussDBforNoSQL SwitchOver

切换实例的主备节点。

去调试

获取SSL证书下载地址

hcloud GaussDBforNoSQL ListSslCertDownloadAddresses

获取SSL证书下载地址。

去调试

设置自动备份策略

hcloud GaussDBforNoSQL SetBackupPolicy

设置自动备份策略。

去调试

查询自动备份策略

hcloud GaussDBforNoSQL ShowBackupPolicy

查询自动备份策略。

去调试

查询可恢复的实例列表

hcloud GaussDBforNoSQL ShowRestorableList

查询用户可恢复的实例列表

去调试

查询实例可恢复的时间段

hcloud GaussDBforNoSQL ListRestoreTime

查询实例可恢复的时间段

去调试

删除手动备份

hcloud GaussDBforNoSQL DeleteBackup

删除手动备份

去调试

停止备份

hcloud GaussDBforNoSQL StopBackup

支持紧急情况下停止备份功能。

去调试

恢复到已有实例

hcloud GaussDBforNoSQL RestoreExistingInstance

恢复到已有实例

去调试

获取GeminiDB(for Cassandra)实例表级恢复的数据库信息

hcloud GaussDBforNoSQL ListRestoreDatabases

获取GeminiDB(for Cassandra)实例表级恢复的数据库信息。

去调试

获取GeminiDB(for Cassandra)实例表级恢复的表信息

hcloud GaussDBforNoSQL ListRestoreTables

获取GeminiDB(for Cassandra)实例表级恢复的表信息。

去调试

查询备份列表

hcloud GaussDBforNoSQL ShowAllInstancesBackups

根据指定条件查询备份列表。

去调试

查询备份列表（推荐）

hcloud GaussDBforNoSQL ShowAllInstancesBackupsNew

根据指定条件查询备份列表。

去调试

查询备份列表（推荐）

hcloud GaussDBforNoSQL ListBackups

根据指定条件查询备份列表。

去调试

创建手动备份

hcloud GaussDBforNoSQL CreateBack

创建手动备份。

去调试

查询回收策略

hcloud GaussDBforNoSQL ShowRecyclePolicy

查询回收策略。

去调试

设置回收策略

hcloud GaussDBforNoSQL SetRecyclePolicy

设置已删除实例保留天数，修改保留天数后删除的实例按照新的天数保留，修改之前已在回收站的实例保留天数不变。

去调试

查询回收站实例列表

hcloud GaussDBforNoSQL ListRecycleInstances

查询回收站所有引擎的实例列表。

去调试

设置Redis恢复到指定时间点策略

hcloud GaussDBforNoSQL SetRedisPitrPolicy

设置Redis恢复到指定时间点策略。

去调试

查询Redis恢复到指定时间点策略

hcloud GaussDBforNoSQL ShowRedisPitrPolicy

查询Redis恢复到指定时间点策略。

去调试

查询Redis可恢复时间点

hcloud GaussDBforNoSQL ListRedisPitrRestoreTime

查询Redis可恢复时间点。

去调试

恢复当前Redis实例到指定时间点

hcloud GaussDBforNoSQL RestoreRedisPitr

恢复当前Redis实例到指定时间点。

去调试

查询Redis实例指定时间点恢复所占用的存储空间

hcloud GaussDBforNoSQL ShowRedisPitrInfo

查询Redis实例指定时间点恢复所占用的存储空间。

去调试

查询自动备份策略

hcloud GaussDBforNoSQL ShowBackupPolicies

查询自动备份策略。

去调试

批量删除手动备份

hcloud GaussDBforNoSQL BatchDeleteManualBackup

批量删除数据库实例的手动备份。

去调试

数据文件导入已有实例

hcloud GaussDBforNoSQL RestoreRedisData

数据导入已有实例。

去调试

重置自定义参数模板

hcloud GaussDBforNoSQL ResetParamGroupTemplate

重置自定义参数模板

去调试

获取参数模板列表

hcloud GaussDBforNoSQL ListConfigurations

获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。

去调试

创建参数模板

hcloud GaussDBforNoSQL CreateConfiguration

创建参数模板。

去调试

获取参数模板列表

hcloud GaussDBforNoSQL ListConfigurationTemplates

获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。

去调试

修改参数模板参数

hcloud GaussDBforNoSQL UpdateConfiguration

修改参数模板参数。

去调试

获取指定参数模板的参数

hcloud GaussDBforNoSQL ShowConfigurationDetail

获取指定参数模板的详细信息。

去调试

删除参数模板

hcloud GaussDBforNoSQL DeleteConfiguration

删除指定参数模板。

去调试

应用参数模板

hcloud GaussDBforNoSQL ApplyConfiguration

将参数模板应用到实例，可以指定一个或多个实例。

去调试

修改指定实例的参数

hcloud GaussDBforNoSQL UpdateInstanceConfiguration

修改指定实例的参数。

去调试

查询实例参数配置

hcloud GaussDBforNoSQL ShowInstanceConfiguration

查询实例参数配置。

去调试

复制参数模板

hcloud GaussDBforNoSQL CopyConfiguration

复制参数模板

去调试

参数模板比较

hcloud GaussDBforNoSQL CompareConfiguration

比较两个参数模板之间的差异

去调试

查询支持参数模板的接口信息

hcloud GaussDBforNoSQL ListConfigurationDatastores

查询支持参数模板的接口信息

去调试

查询参数模板可应用的实例列表

hcloud GaussDBforNoSQL ShowApplicableInstances

查询参数模板可应用的实例列表。

去调试

查询参数组修改历史。

hcloud GaussDBforNoSQL ShowModifyHistory

查询指定实例的参数组修改历史记录，支持分页查询，支持参数搜索。

去调试

查询参数模板应用历史

hcloud GaussDBforNoSQL ShowApplyHistory

-

去调试

应用参数模板

hcloud GaussDBforNoSQL ApplyConfigurationToInstances

将参数模板应用到实例，可以指定一个或多个实例。

去调试

修改指定实例的参数

hcloud GaussDBforNoSQL UpdateInstanceConfigurations

修改指定实例的参数。

去调试

查询资源实例

hcloud GaussDBforNoSQL ListInstancesByTags

根据标签查询指定的数据库实例。

去调试

查询资源实例

hcloud GaussDBforNoSQL ListInstancesByResourceTags

根据标签查询指定的数据库实例。

去调试

批量添加或删除资源标签

hcloud GaussDBforNoSQL BatchTagAction

批量添加或删除指定数据库实例的标签。

去调试

查询资源标签

hcloud GaussDBforNoSQL ListInstanceTags

查询指定实例的标签信息。

去调试

查询项目标签

hcloud GaussDBforNoSQL ListProjectTags

查询指定项目的标签信息。

去调试

设置慢日志脱敏状态

hcloud GaussDBforNoSQL SwitchSlowlogDesensitization

设置慢日志脱敏状态

去调试

查询慢日志脱敏状态

hcloud GaussDBforNoSQL ShowSlowLogDesensitization

查询慢日志脱敏状态。

去调试

查询数据库错误日志信息

hcloud GaussDBforNoSQL ShowErrorLog

查询数据库错误日志

去调试

查询数据库慢日志

hcloud GaussDBforNoSQL ListSlowLogs

查询数据库慢日志信息。

去调试

查询GeminiDB(for Redis)数据库慢日志

hcloud GaussDBforNoSQL ListRedisSlowLogs

查询GeminiDB(for Redis)数据库慢日志信息，支持日志关键字搜索。

去调试

查询GeminiDB(for Cassandra)数据库慢日志

hcloud GaussDBforNoSQL ListCassandraSlowLogs

查询GeminiDB(for Cassandra)数据库慢日志信息，支持日志关键字搜索。

去调试

查询GeminiDB(for Mongo)数据库慢日志

hcloud GaussDBforNoSQL ListMongodbSlowLogs

查询GeminiDB(for Mongo)数据库慢日志信息，支持日志关键字搜索。

去调试

查询GeminiDB(for influxdb)数据库慢日志

hcloud GaussDBforNoSQL ListInfluxdbSlowLogs

查询GeminiDB(for influxdb)数据库慢日志信息，支持日志关键字搜索。

去调试

关联LTS日志流

hcloud GaussDBforNoSQL SaveLtsConfigs

• 将实例日志与LTS日志流关联，后台将自动上传实例日志到关联的LTS日志流里。

去调试

解除关联LTS日志流

hcloud GaussDBforNoSQL DeleteLtsConfigs

将实例日志与LTS日志流解除关联，后台将取消上传实例日志到的LTS日志流里。

去调试

查询LTS日志配置信息

hcloud GaussDBforNoSQL ListLtsConfigs

分页查询实例关联的LTS日志配置信息。

去调试

查询GeminiDB(for Mongo)数据库错误日志

hcloud GaussDBforNoSQL ListMongodbErrorLogs

查询GeminiDB(for Mongo)数据库错误日志信息，支持日志关键字搜索。

去调试

查询配额

hcloud GaussDBforNoSQL ShowQuotas

查询单租户在GeminiDB服务下的资源配额。

去调试

查询企业项目配额

hcloud GaussDBforNoSQL ListEpsQuotas

查询企业项目配额。

去调试

修改企业项目配额

hcloud GaussDBforNoSQL ModifyEpsQuotas

修改企业项目配额。

去调试

设置实例负载均衡的IP访问黑白名单

hcloud GaussDBforNoSQL SwitchIpGroup

设置实例负载均衡的IP访问黑白名单，黑名单、白名单只能选一种，每次调用此接口覆盖之前的设置。关闭后不限制连接的源IP地址。

去调试

查询实例负载均衡的IP访问黑白名单

hcloud GaussDBforNoSQL ShowElbIpGroup

查询实例负载均衡的IP访问黑白名单。

去调试

查询任务列表和详情

hcloud GaussDBforNoSQL ListJobs

查询任务列表和详情，默认查询任务列表。

去调试

操作GeminDB实例数据库

hcloud GaussDBforNoSQL UpdateDatabases

操作GeminDB实例数据库

去调试

重置Redis数据库账号密码

hcloud GaussDBforNoSQL ResetDbUserPassword

重置Redis数据库账号密码。

去调试

修改Redis数据库账号权限

hcloud GaussDBforNoSQL ModifyDbUserPrivilege

修改Redis数据库账号权限。

去调试

创建Redis数据库账号

hcloud GaussDBforNoSQL CreateDbUser

在Redis实例中创建数据库账号。

去调试

删除Redis数据库账号

hcloud GaussDBforNoSQL DeleteDbUser

删除Redis实例的数据库账号。

去调试

获取Redis数据库账号列表和详情

hcloud GaussDBforNoSQL ListDbUsers

获取Redis数据库账号列表和详情。

去调试

获取Redis实例数据库列表

hcloud GaussDBforNoSQL ListInstanceDatabases

获取Redis实例数据库列表。

去调试

关闭实例节点会话

hcloud GaussDBforNoSQL DeleteInstancesSession

关闭实例节点会话。

去调试

获取实例的会话

hcloud GaussDBforNoSQL ListInstanceSessions

获取实例的会话。

去调试

关闭实例所有节点会话

hcloud GaussDBforNoSQL ClearInstanceSessions

关闭实例所有节点会话。

去调试

查询实例节点会话统计信息

hcloud GaussDBforNoSQL ListInstancesSessionStatistics

查询实例节点会话统计信息。

去调试

设置实例容灾切换的故障节点比例

hcloud GaussDBforNoSQL SetDisasterRecoverySettings

设置实例容灾切换的故障节点比例。

去调试

查询实例容灾切换的故障节点比例

hcloud GaussDBforNoSQL ShowDisasterRecoverySettings

查询实例容灾切换的故障节点比例。

去调试

校验实例是否可以与指定实例建立/解除容灾关系

hcloud GaussDBforNoSQL CheckDisasterRecoveryOperation

校验实例是否可以与指定实例建立/解除容灾关系。若接口返回成功，表示可以与指定实例建立/解除容灾关系。

去调试

容灾实例倒换

hcloud GaussDBforNoSQL SwitchOverDisasterRecovery

容灾实例倒换。

去调试

搭建实例与特定实例的容灾关系

hcloud GaussDBforNoSQL CreateDisasterRecovery

搭建实例与特定实例的容灾关系。该接口需要对搭建容灾关系的两个实例分别各调用一次，2次接口都调用成功才能成功搭建容灾关系。

去调试

解除实例与特定实例的容灾关系

hcloud GaussDBforNoSQL DeleteDisasterRecovery

解除实例与特定实例的容灾关系。该接口需要对搭建容灾关系的两个实例分别各调用一次，2次接口都调用成功才能成功解除容灾关系。

去调试

获取容灾实例主/备角色信息

hcloud GaussDBforNoSQL ShowInstanceRole

该接口用于获取容灾实例主/备角色信息，以便后续容灾实例备升主和容灾实例主降备接口调用。

去调试

容灾实例备升主

hcloud GaussDBforNoSQL SwitchToMaster

该接口用于对已经搭建容灾关系的实例，将备实例升级为主实例。

去调试

容灾实例主降备

hcloud GaussDBforNoSQL SwitchToSlave

该接口用于对已经搭建容灾关系的实例，将主实例降级为备实例。

去调试

暂停/恢复具备容灾关系的实例数据同步

hcloud GaussDBforNoSQL PauseResumeDataSynchronization

该接口用于暂停/恢复具备容灾关系的实例数据同步。

去调试

获取容灾实例数据同步状态

hcloud GaussDBforNoSQL ShowPauseResumeStutus

获取容灾实例数据同步状态，主备实例id，数据同步指标值，以及倒换和切换场景下的RPO，RTO指标值。

去调试

搭建双活

hcloud GaussDBforNoSQL CreateGeminiDbDualActive

为了实现跨区域实例数据同步，GeminiDB提供了异地双活功能，即创建异地双活实例。

去调试

解除双活

hcloud GaussDBforNoSQL DeleteGeminiDbDualActive

解除跨区域双活。

去调试

查询实例可搭建双活关系的Region

hcloud GaussDBforNoSQL ShowInstanceBiactiveRegions

查询实例可搭建双活关系的Region。

去调试

修改负载均衡地址

hcloud GaussDBforNoSQL UpdateInstanceLb

修改负载均衡地址。

去调试