CLI Command Reference

Querying Version Information About a DB Engine

hcloud GaussDB ShowGaussMySqlEngineVersion

This API is used to query the version of a specified DB engine.

Go debug

Querying Database Specifications

hcloud GaussDB ShowGaussMySqlFlavors

This API is used to query the specifications of a specified DB engine version.

Go debug

Configuring a Recycling Policy

hcloud GaussDB SetRecyclePolicy

This API is used to configure a recycling policy.

Go debug

Querying a Recycling Policy

hcloud GaussDB ShowRecyclePolicy

This API is used to query a recycling policy.

Go debug

Querying Instances in the Recycle Bin

hcloud GaussDB ListRecycleInstances

This API is used to query instances in the recycle bin.

Go debug

Changing Node Names in Batches

hcloud GaussDB RenameInstanceNode

This API is used to change node names in batches.

Go debug

Querying Historical Records of Auto Scaling

hcloud GaussDB ShowAutoScalingHistory

This API is used to query historical records of auto scaling.

Go debug

Setting a Policy for a Serverless DB Instance

hcloud GaussDB UpdateServerlessPolicy

This API is used to set a policy for a serverless instance.

Go debug

Querying a Serverless Compute Policy

hcloud GaussDB ShowServerlessComputeAbilityPolicy

This API is used to query a serverless compute policy.

Go debug

Querying a Dynamic Serverless Compute Policy

hcloud GaussDB ShowDynamicServerlessPolicy

This API is used to query the dynamic serverless compute policy of an instance.

Go debug

Configuring a Dynamic Serverless Compute Policy

hcloud GaussDB UpdateDynamicServerlessPolicy

This API is used to configure a dynamic serverless compute policy for an instance.

Go debug

Deleting a Dynamic Serverless Compute Policy

hcloud GaussDB DeleteDynamicServerlessPolicy

This API is used to delete the dynamic serverless compute policy of an instance to disable dynamic serverless.

Go debug

Changing the Failover Priority of a Read Replica

hcloud GaussDB ModifyNodePriority

This API is used to change the failover priority of a read replica.

Go debug

Querying an EIP

hcloud GaussDB ShowInstanceEip

This API is used to query an EIP.

Go debug

Creating an Instance

hcloud GaussDB CreateGaussMySqlInstance

This API is used to create a TaurusDB instance.

Go debug

Querying All Instances

hcloud GaussDB ListGaussMySqlInstances

This API is used to query a DB instance list according to search criteria.

Go debug

Batch Changing Instance Specifications

hcloud GaussDB BatchChangeInstanceSpecification

This API is used to change instance specifications in batches.

Go debug

Rebooting a DB instance

hcloud GaussDB RestartGaussMySqlInstance

This API is used to reboot a DB instance.

Go debug

Deleting or Unsubscribing from a DB Instance

hcloud GaussDB DeleteGaussMySqlInstance

This API is used to delete or unsubscribe from a DB instance.

Go debug

Querying Instance Details

hcloud GaussDB ShowGaussMySqlInstanceInfo

This API is used to query instance details.

Go debug

Querying Instance Details in Batches

hcloud GaussDB ListGaussMySqlInstanceDetailInfo

This API is used to query details of instances in batches.

Go debug

Creating a Read Replica

hcloud GaussDB CreateGaussMySqlReadonlyNode

This API is used to create a read replica.

Go debug

Deleting or Unsubscribing from a Read Replica

hcloud GaussDB DeleteGaussMySqlReadonlyNode

This API is used to delete or unsubscribe from a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are deleted or unsubscribed from.

Go debug

Scaling Up Storage of a Yearly/Monthly Instance

hcloud GaussDB ExpandGaussMySqlInstanceVolume

This API is used to scale up storage of a yearly/monthly instance.

Go debug

Changing a DB Instance Name

hcloud GaussDB UpdateGaussMySqlInstanceName

This API is used to change a DB instance name.

Go debug

Resetting a Database Password

hcloud GaussDB ResetGaussMySqlPassword

This API is used to reset a database password.

Go debug

Changing Instance Specifications

hcloud GaussDB ChangeGaussMySqlInstanceSpecification

This API is used to change DB instance specifications.

Go debug

Querying Dedicated Resource Pools

hcloud GaussDB ListGaussMySqlDedicatedResources

This API is used to obtain the dedicated resource pool list, which includes information about all dedicated resource pools you create.

Go debug

Querying Dedicated Resources

hcloud GaussDB ShowDedicatedResourceInfo

This API is used to query dedicated resources.

Go debug

Setting Second-Level Monitoring for an Instance

hcloud GaussDB UpdateInstanceMonitor

Set second-level monitoring for instances, including 1-second monitoring and 5-second monitoring.

Go debug

Querying Second-Level Monitoring of an Instance

hcloud GaussDB ShowInstanceMonitorExtend

This API is used to query second-level monitoring information about an instance.

Go debug

Rebooting a Node

hcloud GaussDB RestartGaussMySqlNode

This API is used to reboot a node.

Go debug

Upgrading the Kernel Version of a DB Instance

hcloud GaussDB UpgradeGaussMySqlInstanceDatabase

This API is used to upgrade the kernel version of a DB instance.

Go debug

Enabling or Disabling SSL

hcloud GaussDB SwitchGaussMySqlInstanceSsl

This API is used to configure SSL to encrypt connections.

Go debug

Binding an EIP

hcloud GaussDB UpdateGaussMySqlInstanceEip

This API is used to bind an EIP to a DB instance.

Go debug

Unbinding an EIP

hcloud GaussDB CancelGaussMySqlInstanceEip

This API is used to unbind an EIP from a DB Instance.

Go debug

Promoting a Read Replica to Primary

hcloud GaussDB InvokeGaussMySqlInstanceSwitchOver

This API is used to promote a read replica to the primary node.

Go debug

Configuring the Maintenance Window

hcloud GaussDB UpdateGaussMySqlInstanceOpsWindow

This API is used to configure the maintenance window. To prevent service interruption, you are advised to set the maintenance window to off-peak hours.

Go debug

Querying Whether an Instance Has Scheduled Tasks of the Same Type

hcloud GaussDB CheckScheduleTaskExist

This API is used to check whether an instance has any scheduled tasks of the same type in the task center.

Go debug

Modifying a Security Group

hcloud GaussDB UpdateGaussMySqlInstanceSecurityGroup

This API is used to modify the security group of a specified DB instance.

Go debug

Changing a Private IP Address

hcloud GaussDB UpdateGaussMySqlInstanceInternalIp

This API is used to change the private IP address of a DB instance.

Go debug

Changing a Database Port

hcloud GaussDB UpdateGaussMySqlInstancePort

This API is used to change the database port of a DB instance.

Go debug

Changing the Description of a DB Instance

hcloud GaussDB UpdateGaussMySqlInstanceAlias

This API is used to change instance description.

Go debug

Apply for a Private Domain Name

hcloud GaussDB CreateGaussMysqlDns

This API is used to apply for a private domain name.

Go debug

Changing a Private Domain Name

hcloud GaussDB ModifyGaussMysqlDns

This API is used to change a private domain name.

Go debug

Querying the Kernel Version

hcloud GaussDB ShowInstanceDatabaseVersion

This API is used to query the kernel version of an instance.

Go debug

Configuring an Auto Scaling Policy

hcloud GaussDB UpdateAutoScalingPolicy

This API is used to configure an auto scaling policy.

Go debug

Querying an Auto Scaling Policy

hcloud GaussDB ShowAutoScalingPolicy

This API is used to query an auto scaling policy.

Go debug

Pre-checking Resources

hcloud GaussDB CheckResource

This API is used to pre-check resources.

Go debug

Querying Instances

hcloud GaussDB ListGaussMySqlInstancesUnifyStatus

This API is used to query instances based on specified criteria.

Go debug

Querying Details of an Instance

hcloud GaussDB ShowGaussMySqlInstanceInfoUnifyStatus

This API is used to query details of an instance.

Go debug

Querying Details of Instances in Batches

hcloud GaussDB ListGaussMySqlInstanceDetailInfoUnifyStatus

This API is used to query details of instances in batches.

Go debug

Querying a Storage Autoscaling Policy

hcloud GaussDB ShowAutoExpandPolicy

This API is used to query a storage autoscaling policy.

Go debug

Modifying a Storage Autoscaling Policy

hcloud GaussDB ModifyAutoExpandPolicy

This API is used to modify a storage autoscaling policy.

Go debug

Querying Proxy Instance Specifications by AZ Code

hcloud GaussDB ShowProxyFlavorsByAzCode

This API is used to query proxy instance specifications by AZ code.

Go debug

Querying Table Information of an Instance

hcloud GaussDB ShowTableMetaInfo

This API is used to query table information of an instance.

Go debug

Upgrading Minor Versions of Instances in Batches

hcloud GaussDB BatchUpgradeDatabases

This API is used to upgrade minor versions of instances in batches.

Go debug

Applying for a Private Domain Name for a Proxy Instance

hcloud GaussDB CreateProxyDnsName

This API is used to apply for a private domain name for a proxy instance.

Go debug

Configuring a Serverless Compute Policy

hcloud GaussDB UpdateServerlessComputeAbilityPolicy

This API is used to configure a serverless compute policy.

Go debug

Querying Custom Scale-Up Policies of a Serverless Instance

hcloud GaussDB ShowServerlessScalingPolicy

This API is used to query custom scale-up policies of a serverless instance.

Go debug

Configuring Custom Scale-Up Policies for a Serverless Instance

hcloud GaussDB UpdateServerlessScalingPolicy

This API is used to configure custom scale-up policies for a serverless instance.

Go debug

Performing an Instance Upgrade Pre-check

hcloud GaussDB CheckKernelUpgrade

This API is used to perform an instance upgrade pre-check.

Go debug

Setting/Canceling the Read-only Status of an Instance

hcloud GaussDB SetInstanceReadonlyStatus

This API is used to set an instance to read-only or cancel the read-only status of an instance.

Go debug

Querying the Instance Upgrade Pre-check Result

hcloud GaussDB ShowKernelUpgradeCheckResult

This API is used to query the instance upgrade pre-check result.

Go debug

Configuring a Backup Policy

hcloud GaussDB UpdateGaussMySqlBackupPolicy

This API is used to configure an automated backup policy.

Go debug

Creating a Manual Backup

hcloud GaussDB CreateGaussMySqlBackup

This API is used to create a manual backup.

Go debug

Querying Full Backups

hcloud GaussDB ShowGaussMySqlBackupList

This API is used to query full backups.

Go debug

Deleting Manual Backups in Batches

hcloud GaussDB BatchDeleteBackup

This API is used to delete manual backups in batches.

Go debug

Querying an Automated Backup Policy

hcloud GaussDB ShowGaussMySqlBackupPolicy

This API is used to query an automated backup policy.

Go debug

Deleting a Manual Backup

hcloud GaussDB DeleteGaussMySqlBackup

This API is used to delete a manual backup.

Go debug

Creating a Backup Resource Package

hcloud GaussDB CreateBackupResourcePackage

This API is used to purchase a yearly/monthly backup resource package.

Go debug

Querying Backup Resource Package Specifications

hcloud GaussDB ShowBackupResourcePackageFlavors

The API is used to query available specifications for a yearly/monthly backup resource package.

Go debug

Restoring a Backup to the Original or Existing DB Instance

hcloud GaussDB RestoreOldInstance

This API is used to restore a backup to the original DB instance or an existing DB instance.

Go debug

Querying the Restoration Time Range

hcloud GaussDB ShowBackupRestoreTime

This API is used to query the recovery time period of a DB instance.

Go debug

Querying Backup Compliance Lock Configurations

hcloud GaussDB ShowBackupVaultLock

This API is used to query backup compliance lock configurations.

Go debug

Enabling or Extending the Backup Compliance Lock

hcloud GaussDB ModifyBackupVaultLock

This API is used to enable or extend the backup compliance lock for an instance.

Go debug

Enabling or Disabling Encrypted Backup

hcloud GaussDB ModifyBackupEncryptStatus

This API is used to enable or disable encrypted backup.

Go debug

Checking Whether Encrypted Backup Is Enabled

hcloud GaussDB DescribeBackupEncryptStatus

This API is used to check whether encrypted backup is enabled.

Go debug

Querying Incremental Backups

hcloud GaussDB ShowGaussMySqlIncrementalBackupList

This API is used to query incremental backups.

Go debug

Configuring a Cross-region Backup Policy

hcloud GaussDB UpdateBackupOffsitePolicy

This API is used to configure a cross-region backup policy.

Go debug

Restoring Tables to a Specified Point in Time

hcloud GaussDB CreateRestoreTables

This API is used to restore tables to a specified point in time.

Go debug

Querying Available Tables for Table-level PITR

hcloud GaussDB ShowRestoreTables

This API is used to query available tables for table-level PITR.

Go debug

Querying Available Tables for Table-level PITR

hcloud GaussDB ShowRestoreAvailableTables

This API is used to query available tables for table-level PITR.

Go debug

Querying the Full Backups of a Specified Instance

hcloud GaussDB ShowInstanceBackups

This API is used to query the full backups of a specified instance.

Go debug

Querying an Automated Backup Policy

hcloud GaussDB ShowTaurusDbAdvancedBackupPolicy

This API is used to query automated backup policies of an instance, including the basic backup policy and sparse backup policy.

Go debug

Configuring a Same-Region Backup Policy

hcloud GaussDB UpdateTaurusDbAdvancedBackupPolicy

This API is used to modify same-region backup policies. You can customize basic backup policies and sparse backup policies.

Go debug

Configuring Same-Region Backup Policies in Batches

hcloud GaussDB BatchUpdateBackupPolicy

This API is used to configure same-region backup policies in batches. Standard and sparse backup policies are supported.

Go debug

Querying Application Records of a Parameter Template

hcloud GaussDB ListParamsTemplateApplyHistory

This API is used to query application records of a parameter template.

Go debug

Querying a Parameter Template

hcloud GaussDB ListGaussMySqlConfigurations

This API is used to obtain parameter templates, including all of the default and custom parameter templates.

Go debug

Creating a Parameter Template

hcloud GaussDB CreateGaussMySqlConfiguration

This API is used to create a parameter template. The following information needs to be configured: template name, description, DB engine version, and parameter values.

Go debug

Deleting a Parameter Template

hcloud GaussDB DeleteGaussMySqlConfiguration

This API is used to delete a specified parameter template.

Go debug

Obtaining Parameter Template Details

hcloud GaussDB ShowGaussMySqlConfiguration

This API is used to obtain parameter details of a specified parameter template.

Go debug

Modifying a Parameter Template

hcloud GaussDB UpdateGaussMySqlConfiguration

This API is used to modify parameters in a specified parameter template, including the parameter names, descriptions, and values.

Go debug

Applying a Parameter Template

hcloud GaussDB SwitchGaussMySqlConfiguration

This API is used to modify a parameter template for a specified DB instance.

Go debug

Replicating a Parameter Template

hcloud GaussDB CopyConfigurations

This API is used to replicate a parameter template.

Go debug

Comparing Parameter Templates

hcloud GaussDB ListConfigurationsDifferences

This API is used to compare two parameter templates.

Go debug

Querying Instances that a Parameter Template Can Be Applied To

hcloud GaussDB ListConfigurationsInstances

This API is used to query instances that a parameter template can be applied to.

Go debug

Viewing Parameter Change History

hcloud GaussDB ListModifyHistory

This API is used to view parameter change history.

Go debug

Obtaining Parameter Information of a Specified Instance

hcloud GaussDB ListInstanceConfigurations

This API is used to obtain parameter information of a specified instance.

Go debug

Modifying Parameters of a Specified Instance

hcloud GaussDB UpdateInstanceConfigurations

This API is used to modify parameters of a specified instance.

Go debug

Replicating a Parameter Template

hcloud GaussDB CopyInstanceConfigurations

This API is used to replicate the parameter template of an instance.

Go debug

Updating a Custom Parameter Template

hcloud GaussDB UpgradeConfiguration

This API is used to update a custom parameter template by synchronizing the parameter values from the default parameter template, including the specification parameter values.

Go debug

Querying the Instance Quota of a Tenant

hcloud GaussDB ShowGaussMySqlProjectQuotas

This API is used to obtain the resource quota of a specified tenant.

Go debug

Querying Enterprise Project Resource Quotas of a Tenant

hcloud GaussDB ShowGaussMySqlQuotas

This API is used to obtain the resource quota of a specified enterprise project.

Go debug

Configuring Enterprise Project Resource Quotas for a Tenant

hcloud GaussDB SetGaussMySqlQuotas

This API is used to set resource quotas for a specified enterprise project.

Go debug

Changing Enterprise Project Resource Quotas for a Tenant

hcloud GaussDB UpdateGaussMySqlQuotas

This API is used to modify the resource quota of a specified enterprise project.

Go debug

Querying Enterprise Projects

hcloud GaussDB ListEnterpriseProjects

This API is used to query enterprise projects.

Go debug

Rebooting a Proxy Instance

hcloud GaussDB RestartProxyInstance

This API is used to reboot a proxy instance

Go debug

Enabling or Disabling ALT for a Proxy Instance

hcloud GaussDB SwitchGaussMySqlProxyAlt

This API is used to enable or disable ALT for a proxy instance.

Go debug

Upgrading the Kernel Version of a Proxy Instance

hcloud GaussDB UpgradeProxyVersion

This API is used to upgrade the kernel version of a proxy instance.

Go debug

Changing the Name of a Proxy Instance

hcloud GaussDB UpdateProxyName

This API is used to change the name of a proxy instance.

Go debug

Querying Access Control Settings of a Proxy Instance

hcloud GaussDB ShowProxyIpgroup

This API is used to query access control settings of a proxy instance.

Go debug

Querying the Minor Version of a Proxy Instance

hcloud GaussDB ShowProxyVersion

This API is used to query the minor version of a proxy instance.

Go debug

Enabling Database Proxy

hcloud GaussDB CreateGaussMySqlProxy

This API is used to enable database proxy in ELB mode.

Go debug

Disabling Database Proxy

hcloud GaussDB DeleteGaussMySqlProxy

This API is used to disable database proxy.

Go debug

Querying Database Proxy Information

hcloud GaussDB ShowGaussMySqlProxyList

This API is used to query the database proxy information.

Go debug

Querying Database Proxy Specifications

hcloud GaussDB ShowGaussMySqlProxyFlavors

This API is used to query database proxy specifications.

Go debug

Adding Database Proxy Nodes

hcloud GaussDB ExpandGaussMySqlProxy

This API is used to add database proxy nodes.

Go debug

Deleting Proxy Nodes

hcloud GaussDB ShrinkGaussMySqlProxy

This API is used to delete proxy nodes.

Go debug

Changing Proxy Instance Specifications

hcloud GaussDB ChangeGaussMySqlProxySpecification

This API is used to change proxy instance specifications.

Go debug

Assigning Read Weights

hcloud GaussDB SetGaussMySqlProxyWeight

This API is used to assign read weights.

Go debug

Changing the Routing Policy of a Proxy Instance

hcloud GaussDB ModifyGaussMySqlProxyRouteMode

This API is used to change the routing policy of a proxy instance.

Go debug

Enabling or Disabling Transaction Splitting

hcloud GaussDB UpdateTransactionSplitStatus

This API is used to enable or disable transaction splitting for a proxy instance.

Go debug

Enabling or Disabling Automatic Association of New Nodes with Proxy Instances

hcloud GaussDB UpdateNewNodeAutoAddSwitch

This API is used to enable or disable automatic association of new nodes with proxy instances.

Go debug

Binding an EIP to or Unbinding an EIP from a Proxy Instance

hcloud GaussDB SwitchGaussMySqlProxyEip

This API is used to bind an EIP to or unbind an EIP from a proxy instance.

Go debug

Changing Proxy Session Consistency

hcloud GaussDB UpdateProxySessionConsistence

This API is used to change the proxy session consistency.

Go debug

Changing the Connection Pool Type of a Proxy Instance

hcloud GaussDB UpdateProxyConnectionPoolType

This API is used to change the connection pool type of a proxy instance.

Go debug

Changing the Port of a Proxy Instance

hcloud GaussDB UpdateProxyPort

This API is used to change the port of a proxy instance.

Go debug

Modifying Parameters of a Proxy Instance

hcloud GaussDB UpdateProxyNewConfigurations

This API is used to modify parameters of a proxy instance.

Go debug

Querying Kernel Parameters of a Proxy Instance

hcloud GaussDB ShowProxyConfigurations

This API is used to query kernel parameters of a proxy instance.

Go debug

Enabling or Disabling Access Control

hcloud GaussDB SwitchAccessControl

This API is used to enable or disable access control.

Go debug

Configuring Access Control Rules

hcloud GaussDB CreateAccessControl

This API is used to configure access control rules.

Go debug

Enabling or Disabling SSL for a Proxy Instance

hcloud GaussDB SwitchGaussMySqlProxySsl

This API is used to enable or disable SSL for a proxy instance.

Go debug

Modifying the Private Domain Name of a Proxy Instance

hcloud GaussDB UpdateProxyPrivateDnsName

This API is used to modify the private domain name of a proxy instance.

Go debug

Deleting the Private Domain Name of a Proxy Instance

hcloud GaussDB DeleteProxyPrivateDnsName

This API is used to delete the private domain name of a proxy instance.

Go debug

Querying LTS Configurations of an Instance

hcloud GaussDB ShowLtsConfigs

This API is used to query LTS configurations of an instance.

Go debug

Deleting LTS Configurations in Batches

hcloud GaussDB DeleteLtsConfigs

This API is used to delete LTS configurations in batches.

Go debug

Creating LTS Configurations in Batches

hcloud GaussDB CreateLtsConfigs

This API is used to create LTS configurations in batches.

Go debug

Querying Whether Show Original Log Is Enabled

hcloud GaussDB ShowSlowlogSensitiveStatus

This API is used to query whether Show Original Log is enabled.

Go debug

Enabling or Disabling Show Original Log

hcloud GaussDB UpdateSlowlogSensitiveSwitch

This API is used to enable or disable Show Original Log.

Go debug

Enabling or Disabling the Audit Log Function

hcloud GaussDB UpdateAuditLog

This API is used to enable or disable SQL Explorer.

Go debug

Querying the Status of the Audit Log Function

hcloud GaussDB ShowAuditLog

This API is used to query whether SQL Explorer is enabled.

Go debug

Obtaining the List of Slow Query Log Details

hcloud GaussDB ListLtsSlowlogDetails

This API is used to obtain the slow query log details list of a specified DB instance.

Go debug

Obtaining the Error Log Details List

hcloud GaussDB ListLtsErrorLogDetails

This API is used to obtain the error log details list of a specified DB instance.

Go debug

Obtaining the Temporary Link for Downloading Full SQL

hcloud GaussDB ListAuditLogDownloadLink

This API is used to obtain the temporary link for downloading full SQL.

Go debug

Querying DDL Logs That Can Be Downloaded

hcloud GaussDB ListDdlLogs

This API is used to query the DDL logs that can be downloaded of a specified instance.

Go debug

Configuring a DDL Log Download Policy

hcloud GaussDB SetDdlLogPolicy

This API is used to configure a DDL log download policy for a specified instance.

Go debug

Obtaining Links for Downloading DDL Logs

hcloud GaussDB DownloadDdlLogs

This API is used to obtain links for downloading DDL logs of a specified instance.

Go debug

Querying Slow Query Log Statistics

hcloud GaussDB ShowSlowLogStatistics

This API is used to query slow query log statistics.

Go debug

Obtaining Links for Downloading Slow Query Logs

hcloud GaussDB DownloadSlowLogFile

This API is used to obtain links for downloading slow query logs.

Go debug

Downloading Error Logs

hcloud GaussDB ShowErrorLogDownloadLink

This API is used to download error logs.

Go debug

Obtaining Audit Logs

hcloud GaussDB ListAuditLogs

This API is used to obtain audit logs.

Go debug

Setting SQL Audit

hcloud GaussDB SetAuditLogPolicy

This API is used to set a policy for audit logs.

Go debug

Querying the Policy for Audit Logs

hcloud GaussDB ShowAuditLogPolicy

This API is used to query the policy for audit logs.

Go debug

Obtaining Links for Downloading Audit Logs

hcloud GaussDB ShowAuditLogDownloadLink

This API is used to obtain links for downloading audit logs.

Go debug

Querying Kernel Slow Query Logs of a StarRocks Instance

hcloud GaussDB ShowSlowLogDetail

This API is used to query kernel slow query logs of a StarRocks instance.

Go debug

Querying Whether Show Original Log Is Enabled for a StarRocks Instance

hcloud GaussDB ShowStarRocksSlowlogSensitiveStatus

This API is used to query whether Show Original Log is enabled for a StarRocks instance.

Go debug

Enabling or Disabling Show Original Log for a StarRocks Instance

hcloud GaussDB UpdateSlowlogSensitiveStatus

This API is used to enable or disable Show Original Log for a StarRocks instance.

Go debug

Querying Resource Tags

hcloud GaussDB ListInstanceTags

This API is used to query tags of a specified resource.

Go debug

Querying Project Tags

hcloud GaussDB ListProjectTags

This API is used to query all tags of a DB instance in a specified project ID.

Go debug

Batch Adding or Deleting Tags

hcloud GaussDB BatchTagAction

This API is used to add or delete tags of a specified DB instance in batches.

Go debug

Creating Database Users

hcloud GaussDB CreateGaussMySqlDatabaseUser

This API is used to create a database account for a TaurusDB instance.

Go debug

Querying Database Users

hcloud GaussDB ListGaussMySqlDatabaseUser

This API is used to query database users of a TaurusDB instance.

Go debug

Deleting Database Users

hcloud GaussDB DeleteGaussMySqlDatabaseUser

This API is used to delete database users.

Go debug

Modifying the Remarks of a Database User

hcloud GaussDB UpdateGaussMySqlDatabaseUserComment

This API is used to modify the description of a database user.

Go debug

Changing Passwords of Database Users

hcloud GaussDB ResetGaussMySqlDatabasePassword

This API is used to change the password of a database user.

Go debug

Authorizing Database Permissions to Database Users

hcloud GaussDB AddDatabasePermission

This API is used to grant permissions to a database user.

Go debug

Deleting Database Permissions of Database Users

hcloud GaussDB DeleteDatabasePermission

This API is used to delete permissions of a database user.

Go debug

Querying Available Database Character Sets

hcloud GaussDB ListGaussMySqlDatabaseCharsets

This API is used to query available database character sets of a TaurusDB instance.

Go debug

Creating Databases

hcloud GaussDB CreateGaussMySqlDatabase

This API is used to create a database for a TaurusDB instance.

Go debug

Querying Databases

hcloud GaussDB ListGaussMySqlDatabase

This API is used to query databases of a TaurusDB instance.

Go debug

Deleting Databases

hcloud GaussDB DeleteGaussMySqlDatabase

This API is used to delete databases from a TaurusDB instance.

Go debug

Modifying Database Remarks

hcloud GaussDB UpdateGaussMySqlDatabaseComment

This API is used to modify the description of a database.

Go debug

Enabling or Disabling SQL Statement Concurrency Control

hcloud GaussDB UpdateSqlFilterControl

This API is used to enable or disable SQL Statement Concurrency Control.

Go debug

Querying Whether SQL Statement Concurrency Control Is Enabled

hcloud GaussDB ShowSqlFilterControl

This API is used to query whether SQL Statement Concurrency Control is enabled.

Go debug

Configuring Concurrency Control Rules of SQL Statements.

hcloud GaussDB SetSqlFilterRule

This API is used to configure concurrency control rules of SQL statements.

Go debug

Querying Concurrency Control Rules of SQL Statements

hcloud GaussDB ShowSqlFilterRule

This API is used to query concurrency control rules of SQL statements.

Go debug

Deleting Concurrency Control Rules of SQL Statements

hcloud GaussDB DeleteSqlFilterRule

This API is used to delete concurrency control rules of SQL statements.

Go debug

Querying Lock Wait Sessions

hcloud GaussDB ShowLockWaitSession

This API is used to query lock wait sessions by node ID and session ID.

Go debug

Querying User Session Threads on a Node

hcloud GaussDB ListTaurusDbNodeProcesses

This API is used to query user session threads on a TaurusDB node by page, similar to the show processlist command. Internal session threads are not returned.

Go debug

Terminating User Session Threads on a Node

hcloud GaussDB DeleteTaurusDbNodeProcesses

This API is used to terminate specified user session threads on a TaurusDB node, excluding any internal session threads passed in.

Go debug

Querying Historical SQL Throttling Rules

hcloud GaussDB ShowHistoricalSqlFilterRule

This API is used to query historical SQL throttling rules.

Go debug

Querying Auto Throttling Rules

hcloud GaussDB ShowSqlAutoSqlLimiting

This API is used to query auto throttling rules.

Go debug

Enabling Auto Throttling

hcloud GaussDB SetAutoSqlLimiting

This API is used to enable auto throttling.

Go debug

Disabling Auto Throttling

hcloud GaussDB DeleteAutoSqlLimiting

This API is used to disable auto throttling.

Go debug

Querying Auto Throttling Records

hcloud GaussDB ShowAutoSqlLimitingLog

This API is used to query auto throttling records.

Go debug

Querying the Execution Progress of a Large Transaction

hcloud GaussDB ShowTaurusDbTxnProgress

This API is used to query the execution progress of transactions based on the transaction ID list. Currently, only the execution progress of rollback transactions can be queried.

Go debug

Obtaining Information About a Task with a Specified ID

hcloud GaussDB ShowGaussMySqlJobInfo

This API is used to obtain information about a task with a specified ID in the TaurusDB task center.

Go debug

Obtaining Instant Tasks

hcloud GaussDB ListImmediateJobs

This API is used to obtain the instant tasks.

Go debug

Obtaining Scheduled Tasks

hcloud GaussDB ListScheduleJobs

This API is used to obtain the scheduled tasks.

Go debug

Canceling a Scheduled Task

hcloud GaussDB CancelScheduleTask

This API is used to cancel a scheduled task.

Go debug

Deleting the Record of a Specific Task

hcloud GaussDB DeleteTaskRecord

This API is used to delete the record of a specific task.

Go debug

Deleting a Scheduled Task Record

hcloud GaussDB DeleteScheduleTasK

This API is used to delete a scheduled task record.

Go debug

Querying Details About a TaurusDB Asynchronous Task

hcloud GaussDB ShowTaskDetails

This API is used to query details about a TaurusDB asynchronous task.

Go debug

Collecting All Real-Time Session Information

hcloud GaussDB CollectRealtimeSession

This API is used to collect all real-time session information of an instance up to the current time.

Go debug

Checking the Status of the Task for Collecting All Real-Time Session Information

hcloud GaussDB ShowRealtimeSessionTaskStatus

This API is used to check the status of the task for collecting all real-time session information of an instance up to the current time.

Go debug

Downloading All Real-Time Session Information

hcloud GaussDB DownloadRealtimeSession

This API is used to download all real-time session information of an instance up to the current time.

Go debug

Querying Abnormal Instances by Each Metric

hcloud GaussDB ShowIntelligentDiagnosisAbnormalCountOfInstances

This API is used to query abnormal instances by each metric.

Go debug

Querying Abnormal Instance Information by a Specific Metric

hcloud GaussDB ShowIntelligentDiagnosisInstanceInfosPerMetric

This API is used to abnormal instance information by a specific metric.

Go debug

Intelligently Killing Sessions

hcloud GaussDB ExecuteIntelligentKillSession

This API is used to intelligently kill sessions. The database automatically selects the top 3 session groups based on the maximum session execution time, number of sessions, and average session execution duration, and kills the sessions in these groups.

Go debug

Querying Intelligently Killed Sessions

hcloud GaussDB ListIntelligentKillSessionHistory

This API is used to query intelligently killed sessions.

Go debug

Showing Intelligently Killed Sessions

hcloud GaussDB ShowIntelligentKillSessionStatistic

This API is used to show intelligently killed sessions.

Go debug

Changing the Specifications of a StarRocks Instance

hcloud GaussDB ResizeStarRocksFlavor

This API is used to change the specifications of a StarRocks instance.

Go debug

Upgrading the Kernel Version of a StarRocks Instance

hcloud GaussDB UpgradeSrKernelVersion

This API is used to upgrade the kernel version of a StarRocks instance.

Go debug

Creating a StarRocks Instance

hcloud GaussDB CreateStarrocksInstance

This API is used to create a StarRocks instance.

Go debug

Querying a StarRocks Instance

hcloud GaussDB ListStarrocksInstanceInfo

This API is used to query a StarRocks instance.

Go debug

Deleting a StarRocks Instance

hcloud GaussDB DeleteStarrocksInstance

This API is used to delete a StarRocks instance.

Go debug

Rebooting a StarRocks Instance

hcloud GaussDB RestartStarrocksInstance

This API is used to reboot a StarRocks instance.

Go debug

Rebooting a StarRocks Node

hcloud GaussDB RestartStarrocksNode

This API is used to reboot a StarRocks node.

Go debug

Checking StarRocks Resources

hcloud GaussDB CheckStarRocksResource

This API is used to check StarRocks resources.

Go debug

Querying HTAP Engine Resources

hcloud GaussDB ListHtapDataStore

This API is used to query HTAP engine resources.

Go debug

Obtaining the Storage Type of an HTAP Instance

hcloud GaussDB ListHtapStorageType

This API is used to obtain the storage type of an HTAP instance.

Go debug

Querying Specifications of an HTAP Instance

hcloud GaussDB ListHtapFlavor

This API is used to query specifications of an HTAP instance.

Go debug

Querying HTAP Instances

hcloud GaussDB ListHtapInstanceInfo

This API is used to query HTAP instances.

Go debug

Querying Database Accounts

hcloud GaussDB ShowStarRocksDatabaseUser

This API is used to query database accounts of a StarRocks instance.

Go debug

Creating a Database Account

hcloud GaussDB CreateStarRocksDatabaseUser

This API is used to create a database account for a StarRocks instance.

Go debug

Deleting a Database Account

hcloud GaussDB DeleteStarRocksDatabaseUser

This API is used to delete a database account of a StarRocks instance.

Go debug

Changing the Password of a Database Account

hcloud GaussDB UpdateStarRocksDatabaseUserPassword

This API is used to change the password of a database account for a StarRocks instance.

Go debug

Changing Permissions of a Database Account

hcloud GaussDB UpdateStarRocksDatabaseUserPermission

This API is used to change permissions of a database account for a StarRocks instance.

Go debug

Creating a Data Synchronization Task for a StarRocks Instance

hcloud GaussDB CreateStarRocksDataReplication

This API is used to create a data synchronization task for a StarRocks instance.

Go debug

Deleting a Data Synchronization Task for a StarRocks Instance

hcloud GaussDB DeleteStarRocksDataReplication

This API is used to delete a data synchronization task for a StarRocks instance.

Go debug

Querying Data Synchronization Tasks of a StarRocks Instance

hcloud GaussDB ListStarRocksDataReplications

This API is used to query data synchronization tasks of a StarRocks instance.

Go debug

Modifying StarRocks Data Synchronization Configurations

hcloud GaussDB ModifyDataSync

This API is used to modify StarRocks data synchronization configurations.

Go debug

Checking Database Configurations for HTAP Data Synchronization

hcloud GaussDB CheckDataBaseConfig

This API is used to check database configurations for HTAP data synchronization.

Go debug

Checking Table Configurations for HTAP Data Synchronization

hcloud GaussDB CheckTableConfig

This API is used to check table configurations for HTAP data synchronization.

Go debug

Querying Configurations of a StarRocks Data Synchronization Task

hcloud GaussDB ListStarRocksDataReplicationConfig

This API is used to query configurations of a StarRocks data synchronization task.

Go debug

Querying Database Parameter Settings for StarRocks Data Synchronization

hcloud GaussDB ListStarRocksDbParameters

This API is used to query database parameter settings for StarRocks data synchronization.

Go debug

Querying Databases of a StarRocks Instance

hcloud GaussDB ListStarRocksDataBases

This API is used to query databases of a StarRocks instance.

Go debug

Restoring a Data Synchronization Task for a StarRocks Instance

hcloud GaussDB ResumeStarRocksDataReplication

This API is used to restore a data synchronization task for a StarRocks instance.

Go debug

Stopping a Data Synchronization Task for a StarRocks Instance

hcloud GaussDB PauseStarRocksDataReplication

This API is used to stop a data synchronization task for a StarRocks instance.

Go debug

Querying StarRocks Data Synchronization Configurations by Destination Database

hcloud GaussDB ListStarRocksDataReplicationConfigByDataBase

This API is used to query StarRocks data synchronization configurations by destination database.

Go debug

Querying Parameters

hcloud GaussDB ShowStarrocksParams

This API is used to query parameters by node type.

Go debug

Modifying Parameters

hcloud GaussDB UpdateStarrocksParams

This API is used to modify parameters by node type.

Go debug

Enabling Assign Requests to Row and Column Store Nodes for a StarRocks Instance

hcloud GaussDB SyncStarRocksUsers

This API is used to enable Assign Requests to Row and Column Store Nodes for a StarRocks instance.

Go debug

Comparing Parameters

hcloud GaussDB CheckStarrocksParams

This API is used to compare instance parameters with those in the default template.

Go debug

Querying Databases of a Primary HTAP Instance

hcloud GaussDB ShowInstanceDatabasesForHtap

This API is used to query databases of a primary HTAP instance.

Go debug

Querying Error Logs

hcloud GaussDB ShowHtapErrorLogDetail

This API is used to query error logs of the kernel.

Go debug

Changing the Security Group of a StarRocks Instance

hcloud GaussDB ModifyStarRocksSecurityGroup

This API is used to change the security group of a StarRocks instance.

Go debug

Querying LTS Configurations of an Instance

hcloud GaussDB ShowHtapLtsConfig

This API is used to query LTS configurations of an instance.

Go debug

Creating LTS Configurations in Batches

hcloud GaussDB UpdateStarRockLtsConfig

This API is used to create LTS configurations in batches.

Go debug

Deleting LTS Configurations in Batches

hcloud GaussDB DeleteStarRockLtsConfig

This API is used to delete LTS configurations in batches.

Go debug

Querying Node Information

hcloud GaussDB ListInstanceNode

This API is used to query node information.

Go debug

Querying Tables of a Primary HTAP Instance

hcloud GaussDB ShowInstanceTablesForHtap

This API is used to query tables of a primary HTAP instance.

Go debug

Enabling or Disabling the Query Queue Function

hcloud GaussDB UpdateHtapQueryQueuesControl

This API is used to enable or disable the query queue function.

Go debug

Querying the Switch Status and Thresholds of the Current Query Queue

hcloud GaussDB ShowHtapQueryQueuesRule

This API is used to query the switch status and thresholds of the current query queue.

Go debug

Setting Thresholds for the Current Query Queue

hcloud GaussDB SetHtapQueryQueuesRule

This API is used to set thresholds for the current query queue.

Go debug

Downloading an HTAP Data Synchronization Template

hcloud GaussDB DownloadImportExcelTemplate

This API is used to download an HTAP data synchronization template.

Go debug

Importing and Verifying HTAP Databases and Tables

hcloud GaussDB UploadImportExcelTemplate

This API is used to import and verify an Excel file for data synchronization.

Go debug

Querying the Current Sessions of an HTAP Instance

hcloud GaussDB ShowHtapProcessList

This API is used to query the current sessions of an HTAP instance.

Go debug

Deleting Sessions of an HTAP Instance

hcloud GaussDB DeleteHtapProcessList

This API is used to delete sessions of an HTAP instance.

Go debug

Enabling or Disabling Multi-tenancy

hcloud GaussDB UpdateMultiTenant

This API is used to enable or disable multi-tenancy.

Go debug

Querying the Status of Multi-tenancy

hcloud GaussDB ShowMultiTenant

This API is used to query the status of multi-tenancy.

Go debug

Querying Cold Table Metadata

hcloud GaussDB ListColdTableMetas

This API is used to query cold table metadata.

Go debug

Performing Operations on Events

hcloud GaussDB SetInstanceScheduleEvents

This API is used to perform operations on events, such as authorizing immediate execution, canceling execution, or authorizing scheduled execution.

Go debug

Obtaining the Event List

hcloud GaussDB ShowInstanceScheduleEvents

This API is used to obtain the event list.

Go debug

Cleaning up Temporary Tables of Lock-Free Change Tasks of an Instance

hcloud GaussDB ClearOnlineDdlTaskTempTable

This API is used to clean up temporary tables generated by lock-free change tasks of an instance.

Go debug

Deleting a Lock-Free Change Task Record of an Instance

hcloud GaussDB DeleteOnlineDdlTaskRecord

This API is used to delete a lock-free change record of an instance.

Go debug

Enabling a Lock-Free Change Task for an Instance

hcloud GaussDB StartOnlineDdlTask

This API is used to enable a lock-free change task for an instance.

Go debug

Obtaining the Download Link of the Log Records of a Lock-Free Change Task

hcloud GaussDB DownloadOnlineDdlTaskLog

This API is used to obtain the download link of the log records of a lock-free change task.

Go debug

Querying Lock-Free Change Task Records

hcloud GaussDB ListOnlineDdlTaskRecords

This API is used to query lock-free change task records.

Go debug

Stopping a Lock-Free Change Task of an Instance

hcloud GaussDB StopOnlineDdlTask

This API is used to stop a lock-free change task of an instance.

Go debug