CLI Command Reference

Obtaining the Resource List via the SecMaster Connector

hcloud DBSS ListDomainAllResource

This API is used to obtain the resource list via SecMaster connector.

Go debug

Obtaining the Total Number of Resources via the SecMaster Connector

hcloud DBSS ShowDomainAllResourceCount

This API is used to obtain the resources via SecMaster connector.

Go debug

Obtaining Instance Monitoring Data

hcloud DBSS ShowInstanceMonitorInfo

This API is used to obtain instance monitoring data.

Go debug

Configuring the Time Zone of an Audit Instance

hcloud DBSS SetAuditInstanceTimeZone

This API is used to configure time zone information of an audit instance.

Go debug

Trigger the audit instance upgrade.

hcloud DBSS ConfirmUpgradeAudit

Trigger the audit instance upgrade.

Go debug

Querying Whether a Tenant's Instance Can Be Upgraded

hcloud DBSS ShowAuditUpgradeStatus

Query whether a tenant's instance can be upgraded.

Go debug

Query the audit instance list.

hcloud DBSS ListAuditInstancesLast

Query the audit instance list.

Go debug

Deleting an Audit Instance

hcloud DBSS DeleteInstancesNew

This operation can be performed only when the pay-per-use instance has no tasks or the yearly/monthly instance is faulty.

Go debug

Querying Account Quota Information

hcloud DBSS ShowAuditQuotaNew

Querying Account Quota Information

Go debug

Querying ECS Specifications

hcloud DBSS ListEcsSpecificationNew

Query ECS specifications.

Go debug

Querying Information About an Instance Creation Task

hcloud DBSS ListAuditInstanceJobsNew

This API is used to query information about an instance creation task.

Go debug

Querying User Operation Logs

hcloud DBSS ListAuditOperateLogsNew

Query user operation logs.

Go debug

Creating an Audit Instance in Yearly/Monthly Billing Mode

hcloud DBSS CreateInstancesPeriodOrderNew

Creating an Audit Instance in Yearly/Monthly Billing Mode

Go debug

Modifying a Security Group

hcloud DBSS UpdateAuditSecurityGroupNew

Modify the security group of an instance.

Go debug

Starting an Audit Instance

hcloud DBSS StartAuditInstanceNew

Start an audit instance.

Go debug

Stopping an Audit Instance

hcloud DBSS StopAuditInstanceNew

Stop an audit instance.

Go debug

Restarting an Audit Instance

hcloud DBSS RebootAuditInstanceNew

Restart an audit instance.

Go debug

Updating Audit Instance Information

hcloud DBSS UpdateAuditInstanceNew

Update audit instance information.

Go debug

Obtaining the log retention time configuration of the audit instance

hcloud DBSS ShowLogRetentionCommonSettings

Obtaining the log retention time configuration of the audit instance

Go debug

Setting the audit instance log retention configuration

hcloud DBSS UpdateLogRetentionCommonSettings

Setting the audit instance log retention configuration

Go debug

Modifying the Name and Path of the Risk Export Bucket (by Domain ID)

hcloud DBSS UpdateAuditRiskBucketPath

Modify the name and path of the risk export bucket (by domain ID).

Go debug

Obtaining the Risk Export Configuration List

hcloud DBSS ListAuditBackupRiskTemplates

Obtain the risk export configuration list.

Go debug

Obtaining the Export Configuration of a Single Risk

hcloud DBSS ShowAuditBackRiskTemplate

Obtain the export configuration of a single risk.

Go debug

Obtaining the Name and Path of the Risk Export Bucket

hcloud DBSS ShowBackupRiskBucketPath

Obtain the name and path of the risk export bucket.

Go debug

Risk Export Switch (by Domain ID)

hcloud DBSS SetAuditBackupRiskSwitch

Risk export switch (by domain ID).

Go debug

Obtaining the Version Information on the Management Side

hcloud DBSS ShowServerVersion

Obtain the version information on the management side.

Go debug

Querying Encryption or Enhanced O&M Quotas

hcloud DBSS ShowInstanceQuota

This API is used to query the encryption/O&M enhancement quota.

Go debug

Querying AZ Information

hcloud DBSS ListAvailabilityZoneInfosNew

Querying AZ Information

Go debug

Updating the Status of a Tenant Audit Information Summary Task

hcloud DBSS UpdateAuditTaskStatus

Update the status of a tenant audit information summary task.

Go debug

Obtaining the Risk Summary of All Instances of a Tenant

hcloud DBSS ShowAuditStatistics

Obtain the risk summary of all the instances of a tenant.

Go debug

Obtaining the Status of the Tenant Audit Information Summary Task

hcloud DBSS ShowAuditTaskStatus

Obtaining the Status of the Tenant Audit Information Summary Task

Go debug

Querying Audit Summary Information

hcloud DBSS ListAuditSummaryInfos

Querying Audit Summary Information

Go debug

Obtaining Details About a Specified SQL Statement

hcloud DBSS ShowSqlDetail

Obtaining Details About a Specified SQL Statement

Go debug

Obtaining SQL Distribution Statistics in a Specified Period

hcloud DBSS CountSqlStatistics

This API is used to query the SQL distribution statistics in a specified period.

Go debug

Obtaining Statistics on Query Sessions in a Specified Period

hcloud DBSS CountSessionStatistics

This API is used to query the session statistics in a specified period.

Go debug

Obtaining the Distribution of Risky Operations in a Specified Period

hcloud DBSS CountOperationStatistics

This API is used to query the risky operations distribution statistics in a specified period.

Go debug

Obtaining SQL Injection Distribution Statistics in a Specified Period

hcloud DBSS CountInjectionStatistics

This API is used to query the SQL injection distribution statistics in a specified period.

Go debug

Obtaining the Distribution of SQL Statements in a Specified Period

hcloud DBSS CountSqlTrendStatistics

This API is used to obtain the distribution of SQL statements in a specified period.

Go debug

Obtaining Risk Distribution Statistics in a Specified Period

hcloud DBSS CountRiskTrendStatistics

This API is used to query the risk distribution statistics in a specified period.

Go debug

Querying Database User Session Distribution

hcloud DBSS CountDbAccountSession

This API is used to query the user session distribution of a database.

Go debug

Querying Client Session Distribution

hcloud DBSS CountDbClientSession

This API is used to query the client session distribution.

Go debug

Querying Historical Trend Data

hcloud DBSS ListAuditTrendHistory

Querying Historical Trend Data

Go debug

Querying Audit SQL Statements

hcloud DBSS ListAuditSqlsNew

Querying Audit SQL Statements

Go debug

Obtaining Privacy Data Result Set Switch

hcloud DBSS ShowSensitiveResultSwitch

Switch for obtaining the privacy data result set

Go debug

Enabling or Disabling Result Set Storage

hcloud DBSS SetSensitiveResultSwitch

This API is used to enable or disable result set storage.

Go debug

Obtaining the Privacy Data Anonymization Switch

hcloud DBSS ShowSensitiveMaskSwitch

This API is used to obtain whether the privacy data masking function is enabled.

Go debug

Enabling or Disabling the Privacy Data Masking Function

hcloud DBSS SetSensitiveSwitch

This API is used to enable or disable the privacy data masking function.

Go debug

Enabling or Disabling a Single Privacy Data Masking Rule

hcloud DBSS SetSensitiveMaskRuleSwitch

Enabling or Disabling a Privacy Data Masking Rule

Go debug

Deleting a Privacy Data Masking Rule

hcloud DBSS DeleteSensitiveRules

This API is used to delete a privacy data masking rule.

Go debug

Modifying and Editing a Privacy Data Masking Rule

hcloud DBSS UpdateSensitiveMaskRule

This API is used to modify a privacy data masking rule.

Go debug

Querying a Privacy Data Masking Rule

hcloud DBSS ListAuditSensitiveMasksNew

This API is used to query a privacy data masking rule.

Go debug

Adding a Privacy Data Anonymization Rule

hcloud DBSS CreateSensitiveMaskRule

This API is used to add privacy data masking rules.

Go debug

Deleting a Policy for an Audit Scope

hcloud DBSS DeleteAuditScope

Delete a policy for an audit scope.

Go debug

Edit Audit Scope Rule

hcloud DBSS UpdateAuditScopeRule

Edit Audit Scope Rule

Go debug

Audit Scope Rule Operations - Deleting a Policy

hcloud DBSS BatchDeleteAuditScope

Audit Scope Rule Operations - Deleting a Policy

Go debug

Enabling/Disabling a policy

hcloud DBSS SetAuditScopeRuleSwitch

Enabling/Disabling a policy

Go debug

Querying the Policy List of an Audit Scope

hcloud DBSS ListAuditRuleScopesNew

Query the policy list of an audit scope.

Go debug

Adding a Policy for an Audit Scope

hcloud DBSS CreateAuditScopeRule

Add a policy for an audit scope.

Go debug

Audit Instance Risk Rule Sorting

hcloud DBSS SetRiskRuleRank

Audit Instance Risk Rule Sorting

Go debug

Deleting a Risk Rule

hcloud DBSS DeleteAuditRuleRisk

Delete a risk policy.

Go debug

Querying a Risk Rule Policy

hcloud DBSS ListAuditRuleRisksNew

Query a risk rule policy.

Go debug

Adding a Risk Rule

hcloud DBSS CreateAuditRiskRule

Adding a Risk Rule

Go debug

Querying a Specified Risk Rule Policy

hcloud DBSS ShowAuditRuleRiskNew

Querying a Specified Risk Rule Policy

Go debug

Editing a Risky Operation Policy

hcloud DBSS SetRiskOperationPolicy

Editing a Risky Operation Policy

Go debug

Enabling or Disabling a Risk Rule

hcloud DBSS SwitchRiskRuleNew

Enabling or Disabling a Risk Rule

Go debug

Deleting a Customized SQL Rule

hcloud DBSS DeleteAuditRuleSql

This API is used to delete customized SQL rules.

Go debug

Editing a Customized SQL Rule

hcloud DBSS UpdateAuditSqlRule

This API is used to edit customized SQL rules.

Go debug

SQL rule priority

hcloud DBSS SetSqlRuleRank

SQL rule priority

Go debug

Adding a Customized SQL Rule

hcloud DBSS CreateAuditSqlRule

Add a customized SQL rule.

Go debug

Enabling or Disabling the SQL Injection Policy

hcloud DBSS SetAuditSqlRuleSwitch

Enabling or Disabling the SQL Injection Policy

Go debug

Querying SQL Injection Rule Policies

hcloud DBSS ListSqlInjectionRulesNew

Querying SQL Injection Rule Policies

Go debug

Adding an Agent by Specifying the Agent ID

hcloud DBSS CreateAuditDbAgent

Adding an Agent by Specifying the Agent ID

Go debug

Enabling/Disabling the Agent

hcloud DBSS SwitchAgentNew

This API is used to enable or disable the agent audit function. An enabled agent collects user access information.

Go debug

Downloading the Audit Agent

hcloud DBSS DownloadAuditAgentNew

Downloading the Audit Agent

Go debug

Deleting a Database Agent

hcloud DBSS DeleteAuditAgentNew

Deleting a Database Agent

Go debug

Querying the Database Agent List

hcloud DBSS ListAuditAgentNew

Querying the Database Agent List

Go debug

Adding an Audit Database Agent

hcloud DBSS AddAuditAgentNew

Adding an Audit Database Agent

Go debug

Batch Marking

hcloud DBSS BatchSetAuditAlarmLogStatus

Batch Marking

Go debug

Deleting the Alarm History

hcloud DBSS DeleteAuditAlarmLog

Delete the alarm history.

Go debug

Marking Monitoring Alarms

hcloud DBSS SetAuditAlarmLogStatus

Mark monitoring alarms.

Go debug

Obtaining Instance Alarm Configurations

hcloud DBSS ListAlarmTopicConfigInfoNew

Obtaining Instance Alarm Configurations

Go debug

Setting Instance Alarm Settings

hcloud DBSS SetAlarmTopicConfigInfoNew

Setting Instance Alarm Settings

Go debug

Querying Audit Alarm Information

hcloud DBSS ListAuditAlarmLogNew

Querying Audit Alarm Information

Go debug

Obtaining Database O&M Cluster Instances

hcloud DBSS ListInstances

Obtaining Database O&M Cluster Instances

Go debug

Changing the Name of a Database O&M Instance

hcloud DBSS UpdateDbOmInstanceName

This API is used to change the name of a database O&M instance.

Go debug

Unbinding an EIP from a Database O&M Instance

hcloud DBSS UnbindDbOmEip

This API is used to unbind an EIP from a database O&M instance.

Go debug

Binding an EIP to a Database O&M Instance

hcloud DBSS BindDbOmEip

This API is used to bind an EIP to a database O&M instance.

Go debug

Changing the Security Group of a Database O&M Instance

hcloud DBSS ChangeDbOmSecurityGroup

This API is used to change the security group of a database O&M instance.

Go debug

Resetting the Password of a Database O&M Instance

hcloud DBSS ResetDbOmPassword

This API Is used to reset the password of a database O&M instance.

Go debug

Restarting a Database O&M Instance

hcloud DBSS RebootDbOmInstance

This API is used to restart a database O&M instance.

Go debug

Stopping a Database O&M Instance

hcloud DBSS StopDbOmInstance

This API is used to stop a database O&M instance.

Go debug

Starting a Database O&M Instance

hcloud DBSS StartDbOmInstance

This API is used to start a database O&M instance.

Go debug

Deleting a Database O&M Instance

hcloud DBSS DeleteDbOmInstance

This API is used to delete a database O&M instance.

Go debug

Buying a Yearly/Monthly Database O&M Instance

hcloud DBSS CreateDbOmInstancePeriod

Buying a Yearly/Monthly Database O&M Instance

Go debug

Listing Database Encryption Instances

hcloud DBSS ListDbEncryptInstances

Listing Database Encryption Instances

Go debug

Changing the Name of a Database Encryption Instance

hcloud DBSS UpdateDbEncryptInstanceName

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

Go debug

Unbinding an EIP from an Encrypted Database Instance

hcloud DBSS UnbindDbEncryptEip

Unbind an EIP from a database encryption instance.

Go debug

Binding the EIP of the Database Encryption Instance

hcloud DBSS BindDbEncryptEip

Bind the EIP of the database encryption instance.

Go debug

Changing the Security Group of an Encrypted Instance

hcloud DBSS ChangeDbEncryptSecurityGroup

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

Go debug

Resetting the Password of an Encrypted Database Instance

hcloud DBSS ResetDbEncryptPassword

This API Is used to reset the password of a database encryption instance.

Go debug

Restarting an Encrypted Database Instance

hcloud DBSS RebootDbEncryptInstance

This API is used to restart an encrypted database instance.

Go debug

Stopping a Database Encryption Instance

hcloud DBSS StopDbEncryptInstance

This API is used to stop an encrypted database instance.

Go debug

Starting the Database Encryption Instance

hcloud DBSS StartDbEncryptInstance

This API is used to start an encrypted database instance.

Go debug

Deleting an Encrypted Database Instance

hcloud DBSS DeleteDbEncryptInstance

This API is used to delete an encrypted database instance.

Go debug

Purchasing an Encrypted Database Instance in Yearly/Monthly Mode

hcloud DBSS CreateDbEncryptInstancePeriod

Purchasing an Encrypted Database Instance in Yearly/Monthly Mode

Go debug

Obtaining All Backup Information

hcloud DBSS ListAuditBackupInfo

Obtaining All Backup Information

Go debug

Enabling/Disabling Backup

hcloud DBSS SetAuditBackupSwitch

Enable/Disable backup.

Go debug

Obtaining the Backup Status

hcloud DBSS ShowAuditBackupStatus

Obtain the backup status.

Go debug

Retrying a Backup Task

hcloud DBSS RetryAuditBackupTask

Retry a backup task.

Go debug

Restoring Backup Information

hcloud DBSS RestoreAuditBackup

Restore backup information.

Go debug

Select an OBS bucket for backup or risk export.

hcloud DBSS ListAuditObsBuckets

Select an OBS bucket for backup or risk export.

Go debug

Deleting a Specified Backup Task

hcloud DBSS DeleteAuditBackupTask

Delete a specified backup task.

Go debug

Obtaining Backup Configuration

hcloud DBSS SetAuditAutoBackupTemplate

Set backup configuration information.

Go debug

Obtaining a Report Template

hcloud DBSS ListAuditReportTemplates

Obtaining a Report Template

Go debug

Deleting a Report

hcloud DBSS DeleteAuditReport

Delete a report.

Go debug

Downloading a Report

hcloud DBSS DownloadAuditReport

Download a report.

Go debug

Modifying the Scheduled Task Configuration of a Report (Topic Mode)

hcloud DBSS UpdateAuditTopicReportSchedulerConfig

Modify the scheduled task configuration of a report (topic mode).

Go debug

Obtaining the Scheduled Task Configuration Information of a Report (Topic Mode)

hcloud DBSS ShowAuditTopicReportSchedulerConfig

Obtaining the Scheduled Task Configuration Information of a Report (Topic Mode)

Go debug

Querying a Report

hcloud DBSS ListAuditReports

Query reports

Go debug

Generating a Report Immediately

hcloud DBSS CreateReport

Generate a report immediately.

Go debug

Modifying a Whitelist

hcloud DBSS UpdateAuditWhitelist

Modify a whitelist.

Go debug

Deleting Whitelists in Batches

hcloud DBSS DeleteAuditWhitelist

Bath Delete Tenants

Go debug

Querying Whitelists

hcloud DBSS ListWhitelists

Querying whitelists

Go debug

Adding Whitelist Records in Batches

hcloud DBSS BatchAddAuditWhitelist

Adding Whitelist Records in Batches

Go debug

Obtaining Instance Tags

hcloud DBSS ListAuditTags

Obtaining Instance Tags

Go debug

Querying resource tags in a specified project.

hcloud DBSS ListProjectResourceTags

Querying resource tags in a specified project.

Go debug

Querying the Resource Instance List by Tag

hcloud DBSS ListResourceInstanceByTag

Querying the Resource Instance List by Tag

Go debug

Querying the Number of Resource Instances by Tag

hcloud DBSS CountResourceInstanceByTag

Querying the Number of Resource Instances by Tag

Go debug

Batch Tagging Resources

hcloud DBSS BatchAddResourceTag

Batch Tagging Resources

Go debug

Batch Deleting Resource Tags

hcloud DBSS BatchDeleteResourceTag

Batch Deleting Resource Tags

Go debug

Obtaining Instance Alarm Configurations (To Be Brought Offline)

hcloud DBSS ListAlarmTopicConfigInfo

This API is used to obtain instance alarm configurations.

Go debug

Setting Instance Alarm Configurations (To Be Brought Offline)

hcloud DBSS SetAlarmTopicConfigInfo

This API is used to set instance alarm configurations.

Go debug

Enabling/Disabling Risk Rules (To Be Taken Offline)

hcloud DBSS SwitchRiskRule

Enabling or Disabling a Risk Rule

Go debug

Querying the Audit Instance List (To Be Brought Offline)

hcloud DBSS ListAuditInstances

This API is used to query the list of audit instances.

Go debug

Deleting an Audit Instance (To Be Brought Offline)

hcloud DBSS DeleteInstances

This operation can be performed only when the pay-per-use instance has no tasks or the yearly/monthly instance is faulty.

Go debug

Querying the Audit Instance List(To Be Brought Offline)

hcloud DBSS ListAuditInstancesNew

Query the audit instance list.

Go debug

Querying Account Quota Information (To Be Brought Offline)

hcloud DBSS ShowAuditQuota

This API is used to query quota information about an account.

Go debug

Querying ECS Specifications (To Be Brought Offline)

hcloud DBSS ListEcsSpecification

This API is used to query ECS specifications.

Go debug

Querying AZ Information (To Be Brought Offline)

hcloud DBSS ListAvailabilityZoneInfos

Querying AZ Information

Go debug

Querying Information About an Instance Creation Task (To Be Brought Offline)

hcloud DBSS ListAuditInstanceJobs

This API is used to query information about an instance creation task.

Go debug

Querying the Database List (To Be Brought Offline)

hcloud DBSS ListAuditDatabases

Querying databases

Go debug

Querying User Operation Logs (To Be Brought Offline)

hcloud DBSS ListAuditOperateLogs

Querying User Operation Logs

Go debug

Querying the Audit Scope Policy List (To Be Brought Offline)

hcloud DBSS ListAuditRuleScopes

Querying the Policy List of an Audit Scope

Go debug

Querying SQL Injection Rules (To Be Brought Offline)

hcloud DBSS ListSqlInjectionRules

Querying SQL Injection Rule Policies

Go debug

Querying Risk Rule Policies (To Be Brought Offline)

hcloud DBSS ListAuditRuleRisks

Querying a Risk Rule Policy

Go debug

Querying a Risk Rule Policy (To Be Brought Offline)

hcloud DBSS ShowAuditRuleRisk

Querying a Specified Risk Rule Policy

Go debug

Querying Privacy Data Desensitization Rules (To Be Brought Offline)

hcloud DBSS ListAuditSensitiveMasks

Querying a Privacy Data Masking Rule

Go debug

Creating an Audit Instance in Yearly/Monthly Billing Mode (To Be Brought Offline)

hcloud DBSS CreateInstancesPeriodOrder

Creating an Audit Instance in Yearly/Monthly Billing Mode

Go debug

Modifying an Instance Security Group (To Be Brought Offline)

hcloud DBSS UpdateAuditSecurityGroup

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

Go debug

Adding an RDS Database (To Be Brought Offline)

hcloud DBSS AddRdsNoAgentDatabase

Add an RDS database. V1 is no longer maintained and will be brought offline.

Go debug

Enabling or Disabling the Agent (To Be Brought Offline)

hcloud DBSS SwitchAgent

This API is used to enable or disable the agent audit function. An enabled agent collects user access information.

Go debug

Adding a Self-Built Database (To Be Brought Offline)

hcloud DBSS AddAuditDatabase

This API is used to add a self-built database.

Go debug

Adding an RDS Database (To Be Brought Offline)

hcloud DBSS AddRdsDatabase

Adding an RDS Database

Go debug

Deleting a Database (To Be Brought Offline)

hcloud DBSS DeleteAuditDatabase

Deleting a Database

Go debug

Enabling and Disabling the Database (To Be Brought Offline)

hcloud DBSS SwitchAuditDatabase

Enabling or Disabling Database

Go debug

Deleting a Database Agent (To Be Brought Offline)

hcloud DBSS DeleteAuditAgent

Deleting a Database Agent

Go debug

Downloading the Audit Agent (to Be Brought Offline)

hcloud DBSS DownloadAuditAgent

Downloading the Audit Agent

Go debug

Enabling an Audit Instance [To Be Brought Offline]

hcloud DBSS StartAuditInstance

This API is used to enable an audit instance.

Go debug

Disabling Audit Instances (To Be Brought Offline)

hcloud DBSS StopAuditInstance

This API is used to disable an audit instance.

Go debug

Restarting an Audit Instance (To Be Brought Offline)

hcloud DBSS RebootAuditInstance

This API is used to restart an audit instance.

Go debug

Updating Audit Instance Information (To Be Brought Offline)

hcloud DBSS UpdateAuditInstance

Updating Audit Instance Information

Go debug

Querying Audit Alarm Information (To Be Brought Offline)

hcloud DBSS ListAuditAlarmLog

Querying Audit Alarm Information

Go debug

Querying Audit SQL Statements (To Be Brought Offline)

hcloud DBSS ListAuditSqls

This API is used to query audit SQL statements.

Go debug

Querying the Database Agent List (To Be Brought Offline)

hcloud DBSS ListAuditAgent

Querying the Database Agent List

Go debug

Adding an Audit Database Agent (to Be Brought Offline)

hcloud DBSS AddAuditAgent

Adding an Audit Database Agent

Go debug

Adding a Self-Built Database

hcloud DBSS AddAuditDatabaseNew

Adding a Self-Built Database

Go debug

Querying databases

hcloud DBSS ListAuditDatabasesNew

Querying databases

Go debug

Adding an RDS Database

hcloud DBSS AddRdsDatabaseNew

Adding an RDS Database

Go debug

Querying the RDS Database List

hcloud DBSS ListRdsDatabases

Querying the RDS Database List

Go debug

Deleting a Database

hcloud DBSS DeleteAuditDatabaseNew

Deleting a Database

Go debug

Export audit database configuration to OBS

hcloud DBSS UploadAuditDbConfig

Export audit database configuration to OBS

Go debug

Uploading or Updating the Database Private Key

hcloud DBSS AddDatabaseSslKey

This API is used to upload or update the database private key.

Go debug

Enabling or Disabling Database

hcloud DBSS SwitchAuditDatabaseNew

Enabling or Disabling Database

Go debug