更新时间:2026-08-28 GMT+08:00
分享

CLI命令参考

查询数据库引擎的版本

API名称

命令

描述

操作

查询数据库引擎的版本

hcloud GaussDB ShowGaussMySqlEngineVersion

获取指定数据库引擎对应的数据库版本信息。

去调试

查询数据库规格

API名称

命令

描述

操作

查询数据库规格

hcloud GaussDB ShowGaussMySqlFlavors

获取指定数据库引擎版本对应的规格信息。

去调试

实例管理

API名称

命令

描述

操作

设置回收站策略

hcloud GaussDB SetRecyclePolicy

设置回收站策略。

去调试

查询回收站策略

hcloud GaussDB ShowRecyclePolicy

查询回收站策略。

去调试

查询回收站实例信息

hcloud GaussDB ListRecycleInstances

查询回收站实例信息。

去调试

批量修改节点名称.

hcloud GaussDB RenameInstanceNode

批量修改节点名称。

去调试

查询自动变配历史记录.

hcloud GaussDB ShowAutoScalingHistory

查询自动变配历史记录。

去调试

设置Serverless配置策略

hcloud GaussDB UpdateServerlessPolicy

设置Serverless配置策略。

去调试

查询Serverless算力策略

hcloud GaussDB ShowServerlessComputeAbilityPolicy

查询Serverless算力策略。

去调试

查询动态Serverless算力策略

hcloud GaussDB ShowDynamicServerlessPolicy

查询实例的动态Serverless算力策略。

去调试

设置动态Serverless算力策略

hcloud GaussDB UpdateDynamicServerlessPolicy

通过设置实例的动态Serverless算力策略,配置动态Serverless功能。

去调试

删除动态Serverless算力策略

hcloud GaussDB DeleteDynamicServerlessPolicy

删除实例的动态Serverless算力策略,关闭动态Serverless功能。

去调试

修改节点故障倒换优先级。

hcloud GaussDB ModifyNodePriority

修改节点故障倒换优先级。

去调试

查询弹性公网IP。

hcloud GaussDB ShowInstanceEip

查询弹性公网IP。

去调试

创建数据库实例

hcloud GaussDB CreateGaussMySqlInstance

创建云数据库TaurusDB实例。

去调试

查询实例列表

hcloud GaussDB ListGaussMySqlInstances

根据指定条件查询实例列表。

去调试

批量变更实例规格

hcloud GaussDB BatchChangeInstanceSpecification

批量变更数据库实例的规格。

去调试

重启数据库实例

hcloud GaussDB RestartGaussMySqlInstance

重启数据库实例。

去调试

删除/退订数据库实例

hcloud GaussDB DeleteGaussMySqlInstance

删除/退订数据库实例。

去调试

查询实例详情信息

hcloud GaussDB ShowGaussMySqlInstanceInfo

查询实例详情信息。

去调试

批量查询实例详情

hcloud GaussDB ListGaussMySqlInstanceDetailInfo

批量查询实例详情。

去调试

创建只读节点

hcloud GaussDB CreateGaussMySqlReadonlyNode

创建只读节点。

去调试

删除/退订只读节点

hcloud GaussDB DeleteGaussMySqlReadonlyNode

删除/退订实例的只读节点。多可用区模式删除/退订只读节点时,要保证删除/退订后,剩余的只读节点和主节点在不同的可用区中,否则无法删除/退订该只读节点。

去调试

包周期存储扩容

hcloud GaussDB ExpandGaussMySqlInstanceVolume

包周期存储扩容。

去调试

修改实例名称

hcloud GaussDB UpdateGaussMySqlInstanceName

修改实例名称。

去调试

重置数据库密码

hcloud GaussDB ResetGaussMySqlPassword

重置数据库密码。

去调试

变更实例规格

hcloud GaussDB ChangeGaussMySqlInstanceSpecification

变更数据库实例的规格。

去调试

查询专属资源池列表

hcloud GaussDB ListGaussMySqlDedicatedResources

获取专属资源池列表,包括用户开通的所有专属资源池信息。

去调试

查询专属资源信息详情

hcloud GaussDB ShowDedicatedResourceInfo

查询专属资源信息详情。

去调试

设置实例秒级监控

hcloud GaussDB UpdateInstanceMonitor

设置实例秒级监控,包括1秒监控和5秒监控。

去调试

查询实例秒级监控

hcloud GaussDB ShowInstanceMonitorExtend

查询实例秒级监控信息。

去调试

节点重启

hcloud GaussDB RestartGaussMySqlNode

节点重启。

去调试

内核版本升级

hcloud GaussDB UpgradeGaussMySqlInstanceDatabase

内核版本升级。

去调试

开关SSL

hcloud GaussDB SwitchGaussMySqlInstanceSsl

为实例设置SSL数据加密。

去调试

绑定弹性公网IP

hcloud GaussDB UpdateGaussMySqlInstanceEip

实例绑定弹性公网IP,供外网连接使用。

去调试

解绑弹性公网IP

hcloud GaussDB CancelGaussMySqlInstanceEip

实例解绑弹性公网IP。

去调试

手动主备倒换

hcloud GaussDB InvokeGaussMySqlInstanceSwitchOver

用户手动进行主备倒换。

去调试

设置可维护时间段

hcloud GaussDB UpdateGaussMySqlInstanceOpsWindow

设置可维护时间段。建议将可维护时间段设置在业务低峰期,避免业务在维护过程中异常中断。

去调试

查询实例是否存在相同定时任务类型

hcloud GaussDB CheckScheduleTaskExist

查询目标实例在任务中心是否有相同的类型的定时任务。

去调试

修改安全组

hcloud GaussDB UpdateGaussMySqlInstanceSecurityGroup

修改指定实例安全组。

去调试

修改内网地址

hcloud GaussDB UpdateGaussMySqlInstanceInternalIp

修改实例内网地址。

去调试

修改实例端口

hcloud GaussDB UpdateGaussMySqlInstancePort

修改实例数据库端口。

去调试

修改实例备注

hcloud GaussDB UpdateGaussMySqlInstanceAlias

修改实例备注。

去调试

申请内网域名

hcloud GaussDB CreateGaussMysqlDns

申请内网域名。

去调试

修改内网域名

hcloud GaussDB ModifyGaussMysqlDns

修改内网域名。

去调试

查询内核版本信息

hcloud GaussDB ShowInstanceDatabaseVersion

查询内核版本信息。

去调试

设置自动变配

hcloud GaussDB UpdateAutoScalingPolicy

设置自动变配。

去调试

查询自动变配

hcloud GaussDB ShowAutoScalingPolicy

查询自动变配。

去调试

资源预校验

hcloud GaussDB CheckResource

资源预校验。

去调试

查询实例列表

hcloud GaussDB ListGaussMySqlInstancesUnifyStatus

根据指定条件查询实例列表。

去调试

查询实例详情信息

hcloud GaussDB ShowGaussMySqlInstanceInfoUnifyStatus

查询实例详情信息。

去调试

批量查询实例详情

hcloud GaussDB ListGaussMySqlInstanceDetailInfoUnifyStatus

批量查询实例详情。

去调试

查询存储空间自动扩容策略。

hcloud GaussDB ShowAutoExpandPolicy

查询存储空间自动扩容策略。

去调试

修改存储空间自动扩容策略。

hcloud GaussDB ModifyAutoExpandPolicy

修改存储空间自动扩容策略。

去调试

根据azCode查询数据库代理规格信息

hcloud GaussDB ShowProxyFlavorsByAzCode

根据azCode查询数据库代理规格信息。

去调试

查询实例库表信息

hcloud GaussDB ShowTableMetaInfo

查询实例库表信息。

去调试

批量实例小版本升级

hcloud GaussDB BatchUpgradeDatabases

批量实例小版本升级。

去调试

开启proxy内网DNS

hcloud GaussDB CreateProxyDnsName

开启proxy内网DNS。

去调试

设置Serverless算力策略

hcloud GaussDB UpdateServerlessComputeAbilityPolicy

设置Serverless算力策略。

去调试

查询Serverless自定义扩容策略

hcloud GaussDB ShowServerlessScalingPolicy

查询Serverless自定义扩容策略。

去调试

设置Serverless自定义扩容策略

hcloud GaussDB UpdateServerlessScalingPolicy

设置Serverless自定义扩容策略。

去调试

实例升级预检查

hcloud GaussDB CheckKernelUpgrade

实例升级预检查。

去调试

设置/解除实例只读

hcloud GaussDB SetInstanceReadonlyStatus

设置实例状态为只读或解读实例的只读状态。

去调试

查询实例升级预检查结果

hcloud GaussDB ShowKernelUpgradeCheckResult

查询实例升级预检查结果。

去调试

备份管理

API名称

命令

描述

操作

设置备份策略

hcloud GaussDB UpdateGaussMySqlBackupPolicy

设置自动备份策略。

去调试

创建手动备份

hcloud GaussDB CreateGaussMySqlBackup

创建手动备份。

去调试

查询全量备份列表

hcloud GaussDB ShowGaussMySqlBackupList

查询全量备份列表。

去调试

批量删除手动备份

hcloud GaussDB BatchDeleteBackup

批量删除手动备份。

去调试

查询自动备份策略

hcloud GaussDB ShowGaussMySqlBackupPolicy

查询自动备份策略。

去调试

删除手动备份

hcloud GaussDB DeleteGaussMySqlBackup

删除手动备份。

去调试

创建备份资源包

hcloud GaussDB CreateBackupResourcePackage

购买新的包年/包月备份资源包。

去调试

查询备份资源包规格

hcloud GaussDB ShowBackupResourcePackageFlavors

查询包年/包月备份资源包的可用规格。

去调试

备份恢复到当前实例或已有实例

hcloud GaussDB RestoreOldInstance

备份恢复到当前实例或已有实例。

去调试

查询可恢复时间段

hcloud GaussDB ShowBackupRestoreTime

查询实例的可恢复时间段。

去调试

查询备份合规锁配置

hcloud GaussDB ShowBackupVaultLock

查询备份合规锁配置。

去调试

打开或延期备份合规锁配置

hcloud GaussDB ModifyBackupVaultLock

打开或延期备份合规锁配置。

去调试

打开或关闭备份加密

hcloud GaussDB ModifyBackupEncryptStatus

打开或关闭备份加密。

去调试

查询实例是否开启备份加密功能

hcloud GaussDB DescribeBackupEncryptStatus

查询实例是否开启备份加密功能。

去调试

查询增量备份列表

hcloud GaussDB ShowGaussMySqlIncrementalBackupList

查询增量备份列表。

去调试

设置跨区备份策略

hcloud GaussDB UpdateBackupOffsitePolicy

设置跨区备份策略。

去调试

表级时间点恢复

hcloud GaussDB CreateRestoreTables

表级时间点恢复。

去调试

查询表级时间点恢复可选表

hcloud GaussDB ShowRestoreTables

查询表级时间点恢复可选表。

去调试

查询表级时间点恢复可选表

hcloud GaussDB ShowRestoreAvailableTables

查询表级时间点恢复可选表。

去调试

查询指定实例全量备份列表

hcloud GaussDB ShowInstanceBackups

查询指定实例全量备份列表。

去调试

查询自动备份策略

hcloud GaussDB ShowTaurusDbAdvancedBackupPolicy

查询实例自动备份策略,包括基础备份策略和稀疏备份策略。

去调试

设置同区域备份策略

hcloud GaussDB UpdateTaurusDbAdvancedBackupPolicy

修改同区域备份策略,支持自定义基础备份策略和稀疏备份策略。

去调试

批量设置同区域备份策略

hcloud GaussDB BatchUpdateBackupPolicy

批量设置同区域备份策略,支持设置普通备份策略和稀疏备份策略。

去调试

参数模板管理

API名称

命令

描述

操作

查询参数模板应用记录。

hcloud GaussDB ListParamsTemplateApplyHistory

查询参数模板应用记录。

去调试

查询参数模板

hcloud GaussDB ListGaussMySqlConfigurations

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

去调试

创建参数模板

hcloud GaussDB CreateGaussMySqlConfiguration

创建参数模板信息,包含参数模板名称、描述、数据库版本信息、参数值。

去调试

删除参数模板

hcloud GaussDB DeleteGaussMySqlConfiguration

删除指定参数模板。

去调试

获取参数模板详情

hcloud GaussDB ShowGaussMySqlConfiguration

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

去调试

修改参数模板

hcloud GaussDB UpdateGaussMySqlConfiguration

修改指定参数模板的参数信息,包括名称、描述、指定参数的值。

去调试

应用参数模板

hcloud GaussDB SwitchGaussMySqlConfiguration

指定实例变更参数模板。

去调试

复制参数组

hcloud GaussDB CopyConfigurations

复制参数组。

去调试

对比参数模板

hcloud GaussDB ListConfigurationsDifferences

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

去调试

查询可应用的实例列表

hcloud GaussDB ListConfigurationsInstances

查询指定参数模板可被应用的实例。

去调试

查询参数修改历史

hcloud GaussDB ListModifyHistory

查询参数修改历史。

去调试

获取指定实例的参数信息

hcloud GaussDB ListInstanceConfigurations

获取指定实例的参数信息。

去调试

修改指定实例的参数

hcloud GaussDB UpdateInstanceConfigurations

修改指定实例的参数。

去调试

复制实例参数组

hcloud GaussDB CopyInstanceConfigurations

复制实例参数组。

去调试

更新自定义参数模板

hcloud GaussDB UpgradeConfiguration

更新自定义参数模板,将模板参数值同步为系统默认模板的值,包含规格参数值。

去调试

配额管理

API名称

命令

描述

操作

查询租户的实例配额

hcloud GaussDB ShowGaussMySqlProjectQuotas

获取指定租户的资源配额。

去调试

查询租户基于企业项目的资源配额

hcloud GaussDB ShowGaussMySqlQuotas

获取指定企业项目的资源配额。

去调试

设置租户基于企业项目的资源配额

hcloud GaussDB SetGaussMySqlQuotas

设置指定企业项目的资源配额。

去调试

修改租户基于企业项目的资源配额

hcloud GaussDB UpdateGaussMySqlQuotas

修改指定企业项目的资源配额。

去调试

查询企业项目

hcloud GaussDB ListEnterpriseProjects

查询企业项目。

去调试

数据库代理

API名称

命令

描述

操作

重启数据库代理.

hcloud GaussDB RestartProxyInstance

重启数据库代理。

去调试

更改数据库代理ALT开关

hcloud GaussDB SwitchGaussMySqlProxyAlt

更改数据库代理ALT开关。

去调试

升级数据库代理实例内核版本

hcloud GaussDB UpgradeProxyVersion

升级数据库代理实例内核版本。

去调试

修改代理实例名称

hcloud GaussDB UpdateProxyName

修改代理实例名称。

去调试

查询代理实例访问控制

hcloud GaussDB ShowProxyIpgroup

查询代理实例访问控制

去调试

查询代理实例小版本

hcloud GaussDB ShowProxyVersion

查询代理实例小版本

去调试

开启数据库代理

hcloud GaussDB CreateGaussMySqlProxy

开启数据库代理,只支持ELB模式。

去调试

关闭数据库代理

hcloud GaussDB DeleteGaussMySqlProxy

关闭数据库代理。

去调试

查询数据库代理信息列表

hcloud GaussDB ShowGaussMySqlProxyList

查询数据库代理信息列表。

去调试

查询数据库代理规格信息

hcloud GaussDB ShowGaussMySqlProxyFlavors

查询数据库代理规格信息。

去调试

扩容数据库代理节点的数量

hcloud GaussDB ExpandGaussMySqlProxy

扩容数据库代理节点的数量。

去调试

减少数据库代理节点的数量

hcloud GaussDB ShrinkGaussMySqlProxy

缩容数据库代理节点的数量。

去调试

数据库代理规格变更

hcloud GaussDB ChangeGaussMySqlProxySpecification

数据库代理规格变更。

去调试

设置读写分离权重

hcloud GaussDB SetGaussMySqlProxyWeight

设置读写分离权重。

去调试

设置读写分离路由模式

hcloud GaussDB ModifyGaussMySqlProxyRouteMode

设置读写分离路由模式。

去调试

设置proxy事务拆分

hcloud GaussDB UpdateTransactionSplitStatus

设置proxy事务拆分。

去调试

开启或关闭新增节点自动加入该Proxy

hcloud GaussDB UpdateNewNodeAutoAddSwitch

开启或关闭新增节点自动加入该Proxy。

去调试

Proxy绑定解绑弹性公网IP

hcloud GaussDB SwitchGaussMySqlProxyEip

Proxy绑定解绑弹性公网IP。

去调试

修改代理会话一致性

hcloud GaussDB UpdateProxySessionConsistence

修改代理会话一致性。

去调试

更改数据库代理连接池类型

hcloud GaussDB UpdateProxyConnectionPoolType

更改数据库代理连接池类型。

去调试

修改读写分离端口号

hcloud GaussDB UpdateProxyPort

修改读写分离端口号。

去调试

修改代理实例参数

hcloud GaussDB UpdateProxyNewConfigurations

修改数据库代理参数。

去调试

查询数据库代理内核参数。

hcloud GaussDB ShowProxyConfigurations

查询数据库代理内核参数。

去调试

开启或关闭访问控制

hcloud GaussDB SwitchAccessControl

开启或关闭访问控制。

去调试

设置访问控制规则

hcloud GaussDB CreateAccessControl

设置访问控制规则。

去调试

开关数据库代理SSL

hcloud GaussDB SwitchGaussMySqlProxySsl

为数据库代理设置SSL数据加密。

去调试

修改proxy内网dns

hcloud GaussDB UpdateProxyPrivateDnsName

修改proxy内网dns

去调试

删除proxy内网dns

hcloud GaussDB DeleteProxyPrivateDnsName

删除proxy内网dns。

去调试

日志管理

API名称

命令

描述

操作

查询实例LTS日志配置列表

hcloud GaussDB ShowLtsConfigs

查询实例LTS日志配置列表。

去调试

批量删除LTS日志配置

hcloud GaussDB DeleteLtsConfigs

批量删除LTS日志配置。

去调试

批量创建LTS日志配置

hcloud GaussDB CreateLtsConfigs

批量创建LTS日志配置。

去调试

查询慢日志脱敏状态

hcloud GaussDB ShowSlowlogSensitiveStatus

查询慢日志脱敏状态。

去调试

开启或关闭慢日志脱敏状态

hcloud GaussDB UpdateSlowlogSensitiveSwitch

开启或关闭慢日志脱敏状态。

去调试

开启或者关闭全量SQL

hcloud GaussDB UpdateAuditLog

开启或者关闭全量SQL。

去调试

查询全量SQL开关状态

hcloud GaussDB ShowAuditLog

查询全量SQL开关状态。

去调试

获取慢日志详情列表

hcloud GaussDB ListLtsSlowlogDetails

获取指定实例的慢日志详情列表。

去调试

获取错误日志详情列表

hcloud GaussDB ListLtsErrorLogDetails

获取指定实例的错误日志详情列表。

去调试

获取全量SQL的临时下载链接

hcloud GaussDB ListAuditLogDownloadLink

获取全量SQL的临时下载链接。

去调试

查询DDL下载日志列表

hcloud GaussDB ListDdlLogs

查询指定实例的DDL下载日志列表。

去调试

设置DDL下载功能的策略

hcloud GaussDB SetDdlLogPolicy

设置指定实例的DDL下载功能的策略。

去调试

获取DDL日志下载链接

hcloud GaussDB DownloadDdlLogs

获取指定实例的DDL日志文件下载链接。

去调试

查询慢日志统计信息

hcloud GaussDB ShowSlowLogStatistics

查询慢日志统计信息。

去调试

获取慢日志下载链接

hcloud GaussDB DownloadSlowLogFile

获取慢日志下载链接。

去调试

错误日志下载

hcloud GaussDB ShowErrorLogDownloadLink

错误日志下载。

去调试

获取审计日志列表

hcloud GaussDB ListAuditLogs

获取审计日志列表。

去调试

设置审计日志策略

hcloud GaussDB SetAuditLogPolicy

设置审计日志策略。

去调试

查询审计日志策略

hcloud GaussDB ShowAuditLogPolicy

查询审计日志策略。

去调试

生成审计日志下载链接

hcloud GaussDB ShowAuditLogDownloadLink

生成审计日志下载链接。

去调试

获取StarRocks实例内核慢日志信息

hcloud GaussDB ShowSlowLogDetail

获取StarRocks实例内核慢日志信息。

去调试

查询StarRocks实例慢日志脱敏状态

hcloud GaussDB ShowStarRocksSlowlogSensitiveStatus

查询StarRocks实例慢日志脱敏状态

去调试

开启或关闭StarRocks实例慢日志脱敏状态

hcloud GaussDB UpdateSlowlogSensitiveStatus

开启或关闭StarRocks实例慢日志脱敏状态

去调试

标签管理

API名称

命令

描述

操作

查询资源标签

hcloud GaussDB ListInstanceTags

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

去调试

查询项目标签

hcloud GaussDB ListProjectTags

查询指定project ID下实例的所有标签集合。

去调试

批量添加或删除标签

hcloud GaussDB BatchTagAction

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

去调试

数据库用户管理

API名称

命令

描述

操作

创建数据库用户

hcloud GaussDB CreateGaussMySqlDatabaseUser

创建云数据库TaurusDB实例数据库用户。

去调试

查询数据库用户

hcloud GaussDB ListGaussMySqlDatabaseUser

查询云数据库 TaurusDB实例数据库用户。

去调试

删除数据库用户

hcloud GaussDB DeleteGaussMySqlDatabaseUser

删除云数据库 TaurusDB实例数据库用户。

去调试

修改数据库用户备注

hcloud GaussDB UpdateGaussMySqlDatabaseUserComment

修改云数据库 TaurusDB实例数据库用户备注。

去调试

修改数据库用户密码

hcloud GaussDB ResetGaussMySqlDatabasePassword

修改云数据库 TaurusDB实例数据库用户密码。

去调试

授予数据库用户数据库权限

hcloud GaussDB AddDatabasePermission

授予云数据库 TaurusDB实例数据库用户数据库权限。

去调试

删除数据库用户的数据库权限

hcloud GaussDB DeleteDatabasePermission

删除云数据库 TaurusDB实例数据库用户的数据库权限。

去调试

数据库管理

API名称

命令

描述

操作

查询数据库可用字符集

hcloud GaussDB ListGaussMySqlDatabaseCharsets

查询云数据库 TaurusDB实例数据库可用字符集。

去调试

创建数据库

hcloud GaussDB CreateGaussMySqlDatabase

创建云数据库 TaurusDB实例数据库。

去调试

查询数据库列表

hcloud GaussDB ListGaussMySqlDatabase

查询 TaurusDB实例数据库。

去调试

删除数据库

hcloud GaussDB DeleteGaussMySqlDatabase

删除云数据库 TaurusDB实例数据库。

去调试

修改数据库备注

hcloud GaussDB UpdateGaussMySqlDatabaseComment

修改云数据库 TaurusDB实例数据库备注。

去调试

流量管理

API名称

命令

描述

操作

开启或者关闭SQL限流

hcloud GaussDB UpdateSqlFilterControl

开启或者关闭SQL限流。

去调试

查询SQL限流开关状态

hcloud GaussDB ShowSqlFilterControl

查询SQL限流开关状态。

去调试

设置SQL限流规则

hcloud GaussDB SetSqlFilterRule

设置SQL限流规则。

去调试

查询SQL限流规则

hcloud GaussDB ShowSqlFilterRule

查询SQL限流规则。

去调试

删除SQL限流规则

hcloud GaussDB DeleteSqlFilterRule

删除SQL限流规则。

去调试

查询锁等待会话信息

hcloud GaussDB ShowLockWaitSession

根据节点ID和会话ID查询锁等待会话信息。

去调试

查询节点用户会话线程

hcloud GaussDB ListTaurusDbNodeProcesses

分页查询TaurusDB节点中的用户会话线程,对应于show processlist命令,返回结果不含内部会话线程。

去调试

终止节点用户会话线程

hcloud GaussDB DeleteTaurusDbNodeProcesses

终止TaurusDB节点中指定的用户会话线程,执行时将排除传入的内部会话线程。

去调试

查询历史SQL限流规则

hcloud GaussDB ShowHistoricalSqlFilterRule

查询历史SQL限流规则。

去调试

查询自治限流规则

hcloud GaussDB ShowSqlAutoSqlLimiting

查询自治限流规则。

去调试

开启自治限流

hcloud GaussDB SetAutoSqlLimiting

开启自治限流。

去调试

关闭自治限流

hcloud GaussDB DeleteAutoSqlLimiting

关闭自治限流。

去调试

查询自治限流执行记录

hcloud GaussDB ShowAutoSqlLimitingLog

查询自治限流执行记录。

去调试

查询大事务执行进度

hcloud GaussDB ShowTaurusDbTxnProgress

根据事务ID列表查询对应事务的执行进度,目前仅支持查询回滚事务的执行进度。

去调试

任务中心

API名称

命令

描述

操作

获取指定ID的任务信息

hcloud GaussDB ShowGaussMySqlJobInfo

获取TaurusDB任务中心指定ID的任务信息。

去调试

获取即时任务列表

hcloud GaussDB ListImmediateJobs

获取即时任务列表。

去调试

获取定时任务列表

hcloud GaussDB ListScheduleJobs

获取定时任务列表。

去调试

取消定时任务

hcloud GaussDB CancelScheduleTask

取消定时任务

去调试

删除指定任务记录

hcloud GaussDB DeleteTaskRecord

删除指定任务记录。

去调试

删除定时任务

hcloud GaussDB DeleteScheduleTasK

删除定时任务。

去调试

获取TaurusDB异步任务详情

hcloud GaussDB ShowTaskDetails

获取TaurusDB异步任务详情。

去调试

智能诊断

API名称

命令

描述

操作

收集全部实时会话信息

hcloud GaussDB CollectRealtimeSession

收集目标实例截止当前时间点的实时会话信息。

去调试

查看收集全部实时会话信息任务状态

hcloud GaussDB ShowRealtimeSessionTaskStatus

查看收集目标实例截止当前时间点的全部实时会话信息任务状态。

去调试

下载全部实时会话信息

hcloud GaussDB DownloadRealtimeSession

下载目标实例截止当前时间点的全部实时会话信息。

去调试

获取各指标的异常实例数

hcloud GaussDB ShowIntelligentDiagnosisAbnormalCountOfInstances

获取各指标的异常实例数。

去调试

获取某个指标的异常实例信息

hcloud GaussDB ShowIntelligentDiagnosisInstanceInfosPerMetric

获取某个指标的异常实例信息。

去调试

执行智能Kill会话动作

hcloud GaussDB ExecuteIntelligentKillSession

执行智能Kill会话动作。数据库根据会话最长执行时间、会话数量和会话平均执行时长排名,自动选择排名前三的组内会话进行智能Kill.

去调试

查询智能Kill会话历史记录

hcloud GaussDB ListIntelligentKillSessionHistory

查询智能Kill会话历史记录。

去调试

预览智能Kill会话结果

hcloud GaussDB ShowIntelligentKillSessionStatistic

预览智能Kill会话结果。

去调试

HTAP-标准版

API名称

命令

描述

操作

StarRocks实例规格变更

hcloud GaussDB ResizeStarRocksFlavor

StarRocks实例规格变更。

去调试

StarRocks内核版本升级

hcloud GaussDB UpgradeSrKernelVersion

StarRocks内核版本升级。

去调试

创建StarRocks实例

hcloud GaussDB CreateStarrocksInstance

创建StarRocks实例。

去调试

查询StarRocks实例

hcloud GaussDB ListStarrocksInstanceInfo

查询StarRocks实例。

去调试

删除StarRocks实例

hcloud GaussDB DeleteStarrocksInstance

删除StarRocks实例。

去调试

重启StarRocks实例

hcloud GaussDB RestartStarrocksInstance

重启StarRocks实例。

去调试

重启StarRocks节点

hcloud GaussDB RestartStarrocksNode

重启StarRocks节点。

去调试

StarRocks资源检查

hcloud GaussDB CheckStarRocksResource

StarRocks资源检查。

去调试

HTAP引擎资源查询

hcloud GaussDB ListHtapDataStore

HTAP引擎资源查询。

去调试

获取HTAP实例存储类型

hcloud GaussDB ListHtapStorageType

获取HTAP实例存储类型。

去调试

HTAP查询规格信息

hcloud GaussDB ListHtapFlavor

HTAP查询规格信息。

去调试

查询HTAP实例列表

hcloud GaussDB ListHtapInstanceInfo

查询HTAP实例列表。

去调试

查询数据库账户

hcloud GaussDB ShowStarRocksDatabaseUser

查询StarRocks数据库账户。

去调试

创建数据库账号

hcloud GaussDB CreateStarRocksDatabaseUser

创建StarRocks数据库账号。

去调试

删除数据库账户

hcloud GaussDB DeleteStarRocksDatabaseUser

删除StarRocks数据库账户。

去调试

修改数据库账号密码

hcloud GaussDB UpdateStarRocksDatabaseUserPassword

修改StarRocks数据库账号密码。

去调试

修改数据库账号权限

hcloud GaussDB UpdateStarRocksDatabaseUserPermission

修改StarRocks数据库账号权限。

去调试

创建StarRocks数据同步

hcloud GaussDB CreateStarRocksDataReplication

创建StarRocks数据同步。

去调试

删除StarRocks数据同步

hcloud GaussDB DeleteStarRocksDataReplication

删除StarRocks数据同步。

去调试

查询StarRocks数据同步状态信息

hcloud GaussDB ListStarRocksDataReplications

查询StarRocks数据同步状态信息。

去调试

修改StarRocks数据同步配置

hcloud GaussDB ModifyDataSync

修改StarRocks数据同步配置。

去调试

HTAP数据同步库配置校验

hcloud GaussDB CheckDataBaseConfig

HTAP数据同步库配置校验。

去调试

HTAP数据同步表配置校验

hcloud GaussDB CheckTableConfig

HTAP数据同步表配置校验。

去调试

查询StarRocks数据同步配置信息

hcloud GaussDB ListStarRocksDataReplicationConfig

查询StarRocks数据同步配置信息。

去调试

查询StarRocks数据同步的库参数配置

hcloud GaussDB ListStarRocksDbParameters

查询StarRocks数据同步的库参数配置。

去调试

查询StarRocks数据库

hcloud GaussDB ListStarRocksDataBases

查询StarRocks数据库。

去调试

恢复StarRocks数据同步

hcloud GaussDB ResumeStarRocksDataReplication

恢复StarRocks数据同步。

去调试

暂停StarRocks数据同步

hcloud GaussDB PauseStarRocksDataReplication

暂停StarRocks数据同步。

去调试

按目标库查询StarRocks数据同步配置信息

hcloud GaussDB ListStarRocksDataReplicationConfigByDataBase

按目标库查询StarRocks数据同步配置信息。

去调试

查询参数

hcloud GaussDB ShowStarrocksParams

按节点类型查询参数

去调试

修改参数

hcloud GaussDB UpdateStarrocksParams

按节点类型修改节点参数

去调试

StarRocks实例开启行列分流

hcloud GaussDB SyncStarRocksUsers

StarRocks实例开启行列分流。

去调试

参数对比

hcloud GaussDB CheckStarrocksParams

对比实例参数和默认模板的差异

去调试

查询HTAP主实例数据库

hcloud GaussDB ShowInstanceDatabasesForHtap

查询HTAP主实例数据库。

去调试

查询错误日志

hcloud GaussDB ShowHtapErrorLogDetail

获取内核错误日志信息

去调试

修改StarRocks安全组

hcloud GaussDB ModifyStarRocksSecurityGroup

修改StarRocks安全组。

去调试

查询实例LTS日志配置列表

hcloud GaussDB ShowHtapLtsConfig

查询实例LTS日志配置列表

去调试

批量创建LTS日志配置

hcloud GaussDB UpdateStarRockLtsConfig

批量创建LTS日志配置。

去调试

批量解除LTS日志配置

hcloud GaussDB DeleteStarRockLtsConfig

批量解除LTS日志配置。

去调试

查询节点信息

hcloud GaussDB ListInstanceNode

查询节点信息

去调试

查询HTAP主实例数据库表列表

hcloud GaussDB ShowInstanceTablesForHtap

查询HTAP主实例数据表列表。

去调试

开启或者关闭查询队列功能

hcloud GaussDB UpdateHtapQueryQueuesControl

开启或者关闭查询队列功能。

去调试

查询当前查询队列开关和阈值

hcloud GaussDB ShowHtapQueryQueuesRule

查询当前查询队列开关和阈值。

去调试

设置当前查询队列阈值

hcloud GaussDB SetHtapQueryQueuesRule

设置当前查询队列阈值。

去调试

HTAP数据同步模板下载

hcloud GaussDB DownloadImportExcelTemplate

HTAP数据同步模板下载。

去调试

HTAP库表导入校验

hcloud GaussDB UploadImportExcelTemplate

创建数据同步时支持Excel导入并进行校验。

去调试

查询HTAP实例当前会话

hcloud GaussDB ShowHtapProcessList

查询HTAP实例当前会话。

去调试

删除HTAP实例会话

hcloud GaussDB DeleteHtapProcessList

删除HTAP实例会话。

去调试

多租特性

API名称

命令

描述

操作

开启或者关闭多租特性

hcloud GaussDB UpdateMultiTenant

开启或者关闭多租特性。

去调试

查询多租特性开关状态

hcloud GaussDB ShowMultiTenant

查询多租特性开关状态。

去调试

冷热分离

API名称

命令

描述

操作

查询冷表元信息

hcloud GaussDB ListColdTableMetas

查询冷表元信息。

去调试

事件管理

API名称

命令

描述

操作

操作事件

hcloud GaussDB SetInstanceScheduleEvents

对事件进行授权立即执行、授权取消执行或者授权预约执行等操作。

去调试

获取事件列表

hcloud GaussDB ShowInstanceScheduleEvents

获取事件列表。

去调试

无锁变更

API名称

命令

描述

操作

清理实例无锁变更任务临时表

hcloud GaussDB ClearOnlineDdlTaskTempTable

清理实例无锁变更任务产生的临时表。

去调试

删除实例无锁变更任务记录

hcloud GaussDB DeleteOnlineDdlTaskRecord

删除实例无锁变更记录。

去调试

开启实例无锁变更任务

hcloud GaussDB StartOnlineDdlTask

开启实例无锁变更任务。

去调试

获取实例无锁变更任务日志记录下载链接

hcloud GaussDB DownloadOnlineDdlTaskLog

获取实例无锁变更任务日志记录下载链接。

去调试

查询无锁变更任务记录列表

hcloud GaussDB ListOnlineDdlTaskRecords

查询无锁变更任务记录列表。

去调试

停止实例无锁变更任务

hcloud GaussDB StopOnlineDdlTask

停止实例无锁变更任务。

去调试

相关文档