CLI Command Reference
Instance Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Use the input configuration to overwrite the current pg_hba.conf file. If the input parameter is empty, use the default configuration to overwrite the current pg_hba.conf file. | hcloud RDS AddPostgresqlHbaConf | Use the input configuration to overwrite the current pg_hba.conf file. If the input parameter is empty, use the default configuration to overwrite the current pg_hba.conf file. | |
| Binding and Unbinding an EIP | hcloud RDS AttachEip | Binding and Unbinding an EIP | |
| batch delete instance | hcloud RDS BatchDeleteInstance | batch delete instance | |
| Batch resize instance specifications | hcloud RDS BatchResizeFlavor | Batch resize instance specifications | |
| Stopping Database Instances in Batches | hcloud RDS BatchStopInstance | Stopping Database Instances in Batches | |
| Changing the Data Replication Mode of Primary/Standby DB Instances | hcloud RDS ChangeFailoverMode | Changing the Data Replication Mode of Primary/Standby DB Instances | |
| Changing the Failover Priority | hcloud RDS ChangeFailoverStrategy | Changing the Failover Priority | |
| Configuring the Maintenance Window | hcloud RDS ChangeOpsWindow | Configuring the Maintenance Window | |
| Major Upgrade Precheck | hcloud RDS CheckInstanceForUpgrade | Major Upgrade Precheck | |
| Applying for a Private Domain Name | hcloud RDS CreateDnsName | Applying for a Private Domain Name | |
| Creating a DRS Synchronization Task | hcloud RDS CreateDrsJobTask | Creating a DRS Synchronization Task | |
| Creating a DB Instance | hcloud RDS CreateInstance | Creating a DB Instance | |
| V5 version interface for creating a DB Instance, only support IAM5 auth method (AK/SK auth method). | hcloud RDS CreateInstanceIam5 | V5 version interface for creating a DB Instance, only support IAM5 auth method (AK/SK auth method). | |
| Rebuild the slave machine | hcloud RDS CreateRebuildSlave | Rebuild the slave machine | |
| Added SQL traffic limiting. | hcloud RDS CreateSqlLimit | Added SQL traffic limiting. | |
| Deleting a DB Instance | hcloud RDS DeleteInstance | Deleting a DB Instance | |
| Delete one or more configurations from the pg_hba.conf file | hcloud RDS DeletePostgresqlHbaConf | Delete one or more configurations from the pg_hba.conf file | |
| Deleting SQL Flow Control | hcloud RDS DeleteSqlLimit | Deleting SQL Flow Control | |
| list auto-scale policy | hcloud RDS ListAutoScalingPolicy | list auto-scale policy | |
| Querying Available SQL Server Character Sets | hcloud RDS ListCollations | Querying Available SQL Server Character Sets | |
| Querying instances can change specifications | hcloud RDS ListEngineFlavors | Querying instances can change specifications | |
| API for Querying the Specifications That Can Be Changed in the Database | hcloud RDS ListFlavorsResize | API for Querying the Specifications That Can Be Changed in the Database | |
| Query history sessions. | hcloud RDS ListHistorySessions | Query history sessions. | |
| Query history TOP SQL (instantaneous) | hcloud RDS ListHistoryTopSqls | Query history TOP SQL (instantaneous) | |
| Query history wait events. | hcloud RDS ListHistoryWaitEvents | Query history wait events. | |
| Querying the Major Version Upgrade Check History of a DB Instance | hcloud RDS ListInspectionHistories | Querying the Major Version Upgrade Check History of a DB Instance | |
| query the number of diagnosed instances | hcloud RDS ListInstanceDiagnosis | query the number of diagnosed instances | |
| Querying Details About DB Instances | hcloud RDS ListInstances | Querying Details About DB Instances | |
| query the diagnosis result of a specified diagnosis item | hcloud RDS ListInstancesInfoDiagnosis | query the diagnosis result of a specified diagnosis item | |
| Querying Configurations in the pg_hba.conf File of an Instance | hcloud RDS ListPostgresqlHbaInfo | Querying Configurations in the pg_hba.conf File of an Instance | |
| Queries the modification history of the pg_hba.conf file of an instance. | hcloud RDS ListPostgresqlHbaInfoHistory | Queries the modification history of the pg_hba.conf file of an instance. | |
| Querying Databases That Can Be Restored from a Read Replica to a Primary DB Instance | hcloud RDS ListReadOnlyReplayDatabase | Querying Databases That Can Be Restored from a Read Replica to a Primary DB Instance | |
| Querying the SQL Flow Control List | hcloud RDS ListSqlLimit | Querying the SQL Flow Control List | |
| Gets the download link of ssl certificates. | hcloud RDS ListSslCertDownloadLink | Gets the download link of ssl certificates. | |
| Querying Top SQL-related Information. | hcloud RDS ListTopSqls | Querying Top SQL-related Information. | |
| Querying the Major Version Upgrade History of a DB Instance | hcloud RDS ListUpgradeHistories | Querying the Major Version Upgrade History of a DB Instance | |
| Query disk information of an instance | hcloud RDS ListVolumeInfo | Query disk information of an instance | |
| Migrating a Standby DB Instance | hcloud RDS MigrateFollower | Migrating a Standby DB Instance | |
| Modify one or more configurations in the pg_hba.conf file. | hcloud RDS ModifyPostgresqlHbaConf | Modify one or more configurations in the pg_hba.conf file. | |
| Delivering Restoration Delayed Database Read-only to the Primary DB Instance | hcloud RDS RestoreLogReplayDatabase | Delivering Restoration Delayed Database Read-only to the Primary DB Instance | |
| Configuring an Autoscaling Policy | hcloud RDS SetAutoEnlargePolicy | Configuring an Autoscaling Policy | |
| Setting the Automatic Upgrade Policy for Instance Kernel Minor Versions | hcloud RDS SetAutoUpgradePolicy | Setting the Automatic Upgrade Policy for Instance Kernel Minor Versions | |
| Instance Management | hcloud RDS SetSecondLevelMonitor | Instance Management | |
| Querying an Autoscaling Policy | hcloud RDS ShowAutoEnlargePolicy | Querying an Autoscaling Policy | |
| Querying the Automatic Upgrade Policy of a Small Kernel Version of an Instance | hcloud RDS ShowAutoUpgradePolicy | Querying the Automatic Upgrade Policy of a Small Kernel Version of an Instance | |
| Query the primary instances or DR instances that can be used to set up disaster recovery. | hcloud RDS ShowAvailableBuildDrInstance | Query the primary instances or DR instances that can be used to set up disaster recovery. | |
| Querying the Target Version to Which a DB Instance Can Be Upgraded | hcloud RDS ShowAvailableVersion | Querying the Target Version to Which a DB Instance Can Be Upgraded | |
| Querying the IPv6 Domain Name of a DB Instance | hcloud RDS ShowDnsName | Querying the IPv6 domain name of an instance. | |
| Querying the IPv4 Domain Name of a DB Instance | hcloud RDS ShowDomainName | Querying the IPv4 domain name of an instance. | |
| Querying the DRS Task Name of an Instance | hcloud RDS ShowDrsJobName | Querying the DRS Task Name of an Instance | |
| Query the download information for history session analysis. | hcloud RDS ShowHistorySessionAnalyseDownloadInfo | Query the download information for history session analysis. | |
| Obtain the pre-check result for upgrading MySQL 5.7 to MySQL 8.0 | hcloud RDS ShowPrecheckResult | Obtain the pre-check result for upgrading MySQL 5.7 to MySQL 8.0 | |
| Query the status of the rebuilt secondary server | hcloud RDS ShowRebuildSlaveStatus | Query the status of the rebuilt secondary server | |
| Gets the replication status of the instance. | hcloud RDS ShowReplicationStatus | Gets the replication status of the instance. | |
| Querying a Monitoring by Seconds Policy | hcloud RDS ShowSecondLevelMonitoring | Querying a Monitoring by Seconds Policy | |
| Query instance storage space usage | hcloud RDS ShowStorageUsedSpace | Query instance storage space usage | |
| Query top objects. | hcloud RDS ShowTopObjects | Query top objects. | |
| Querying the Major Version Check Status or Upgrade Status of a DB Instance | hcloud RDS ShowUpgradeDbMajorVersionStatus | Querying the Major Version Check Status or Upgrade Status of a DB Instance | |
| Manually Switching Primary/Standby DB Instances | hcloud RDS StartFailover | Manually Switching Primary/Standby DB Instances | |
| Scaling Up Storage Space of a DB Instance | hcloud RDS StartInstanceEnlargeVolumeAction | Scaling Up Storage Space of a DB Instance | |
| Shrinking disk space of a DB instance | hcloud RDS StartInstanceReduceVolumeAction | Shrinking disk space of a DB instance | |
| Rebooting a DB Instance | hcloud RDS StartInstanceRestartAction | Rebooting a DB Instance | |
| Changing a Single DB Instance to Primary/Standby DB Instances | hcloud RDS StartInstanceSingleToHaAction | Changing a Single DB Instance to Primary/Standby DB Instances | |
| Changing DB Instance Specifications | hcloud RDS StartResizeFlavorAction | Changing DB Instance Specifications | |
| Starting a DB Instance | hcloud RDS StartupInstance | Starting a DB Instance | |
| Stopping a DB instance | hcloud RDS StopInstance | Stopping a DB instance | |
| Enabling, Disabling, or Disabling All SQL Flow Control Functions | hcloud RDS SwitchSqlLimit | Enabling, Disabling, or Disabling All SQL Flow Control Functions | |
| Interface for Canceling the Read Only Status of a Node | hcloud RDS UnlockNodeReadonlyStatus | Interface for Canceling the Read Only Status of a Node | |
| Modifying a Private Domain Name | hcloud RDS UpdateDnsName | Modifying a Private Domain Name | |
| Changing a DB Instance Description | hcloud RDS UpdateInstanceAlias | Changing a DB Instance Description | |
| Changing a DB Instance Name | hcloud RDS UpdateInstanceName | Changing a DB Instance Name | |
| Modifying SQL Traffic Limiting | hcloud RDS UpdateSqlLimit | Modifying SQL Traffic Limiting | |
| RDS instance on-demand to period | hcloud RDS UpdateToPeriod | RDS instance on-demand to period | |
| Upgrading a Major Version of a DB Instance | hcloud RDS UpgradeDbMajorVersion | Upgrading a Major Version of a DB Instance | |
| Performing a Major Version Upgrade Pre-Check for a DB Instance | hcloud RDS UpgradeDbMajorVersionPreCheck | Performing a Major Version Upgrade Pre-Check for a DB Instance | |
| Upgrading a Minor Version | hcloud RDS UpgradeDbVersion | Upgrading a Minor Version | |
| Upgrading a Minor Version | hcloud RDS UpgradeDbVersionNew | Upgrading a Minor Version | |
| MySQL Major Version Upgrade | hcloud RDS UpgradeLargeVersion | MySQL Major Version Upgrade | |
| Upload history session analysis | hcloud RDS UploadHistorySessionAnalyase | Upload history session analysis |
Database and Account Management (PostgreSQL)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Authorizing a Database Account | hcloud RDS AllowDbPrivilege | Authorizing a Database Account | |
| Creating a Database | hcloud RDS CreatePostgresqlDatabase | Creating a Database | |
| Creating a Database Schema | hcloud RDS CreatePostgresqlDatabaseSchema | Creating a Database Schema | |
| Creating a Database Account | hcloud RDS CreatePostgresqlDbUser | Creating a Database Account | |
| Create extension | hcloud RDS CreatePostgresqlExtension | Create extension | |
| Deleting a Database | hcloud RDS DeletePostgresqlDatabase | Deleting a Database | |
| Deleting a Database Account | hcloud RDS DeletePostgresqlDbUser | Deleting a Database Account | |
| Delete extension | hcloud RDS DeletePostgresqlExtension | Delete extension | |
| Granting user roles | hcloud RDS ExecutePrivilegeDatabaseUserRole | Granting user roles | |
| Revoke user role | hcloud RDS ExecuteRevokeDatabaseUserRole | Revoke user role | |
| Query database role information | hcloud RDS ListDatabaseUserRole | Query database role information | |
| Querying Details About Databases | hcloud RDS ListPostgresqlDatabases | Querying Details About Databases | |
| Querying Details About Database Schemas | hcloud RDS ListPostgresqlDatabaseSchemas | Querying Details About Database Schemas | |
| Querying Details About Database Users | hcloud RDS ListPostgresqlDbUserPaginated | Querying Details About Database Users | |
| Query extensions. | hcloud RDS ListPostgresqlExtension | Query extensions. | |
| Revoke database account permissions | hcloud RDS RevokePostgresqlDbPrivilege | Revoke database account permissions | |
| Setting Database User Permissions | hcloud RDS SetDatabaseUserPrivilege | Setting Database User Permissions | |
| Resetting a Password for a Database Account | hcloud RDS SetPostgresqlDbUserPwd | Resetting a Password for a Database Account | |
| Gets the value of the instance specified parameter | hcloud RDS ShowPostgresqlParamValue | Gets the value of the instance specified parameter | |
| update database owner | hcloud RDS UpdateDatabaseOwner | update database owner | |
| Modifying the Database Remarks of a Specified DB Instance | hcloud RDS UpdatePostgresqlDatabase | Modifying the Database Remarks of a Specified DB Instance | |
| This API is used to modify the remarks of a database account. | hcloud RDS UpdatePostgresqlDbUserComment | This API is used to modify the remarks of a database account. | |
| Update extension | hcloud RDS UpdatePostgresqlExtension | Update extension | |
| Modifies the value of an instance specified parameter | hcloud RDS UpdatePostgresqlParameterValue | Modifies the value of an instance specified parameter |
Database and Account Management (MySQL)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Authorizing a Database Account | hcloud RDS AllowDbUserPrivilege | Authorizing a Database Account | |
| Creating a Database | hcloud RDS CreateDatabase | Creating a Database | |
| Creating a Database Account | hcloud RDS CreateDbUser | Creating a Database Account | |
| Deleting a Database | hcloud RDS DeleteDatabase | Deleting a Database | |
| Deleting a Database Account | hcloud RDS DeleteDbUser | Deleting a Database Account | |
| Querying Authorized Databases of a Specified User | hcloud RDS ListAuthorizedDatabases | Querying Authorized Databases of a Specified User | |
| Querying Authorized Users of a Specified Database | hcloud RDS ListAuthorizedDbUsers | Querying Authorized Users of a Specified Database | |
| Querying Details About Databases | hcloud RDS ListDatabases | Querying Details About Databases | |
| Querying Details About Database Users | hcloud RDS ListDbUsers | Querying Details About Database Users | |
| Resetting a Database Password | hcloud RDS ResetPwd | Resetting a Database Password | |
| Revoking Permissions of a Database Account | hcloud RDS Revoke | Revoking Permissions of a Database Account | |
| Configuring a Password for a Database Account | hcloud RDS SetDbUserPwd | Configuring a Password for a Database Account | |
| Setting Instance Permissions to Read-Only | hcloud RDS SetReadOnlySwitch | Setting Instance Permissions to Read-Only | |
| Modifying the Database Remarks of a Specified DB Instance | hcloud RDS UpdateDatabase | Modifying the Database Remarks of a Specified DB Instance | |
| This API is used to modify the remarks of a database account. | hcloud RDS UpdateDbUserComment | This API is used to modify the remarks of a database account. | |
| Modify host of database users. | hcloud RDS UpdateHostPrivilege | Modify host of database users. |
Database and Account Management (Microsoft SQL Server)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Authorizing a Database Account | hcloud RDS AllowSqlserverDbUserPrivilege | Authorizing a Database Account | |
| Creating a Database | hcloud RDS CreateSqlserverDatabase | Creating a Database | |
| Creating a Database Account | hcloud RDS CreateSqlserverDbUser | Creating a Database Account | |
| Deleting a Database | hcloud RDS DeleteSqlserverDatabase | Deleting a Database | |
| Deleting a Database Account | hcloud RDS DeleteSqlserverDbUser | Deleting a Database Account | |
| Querying Authorized Users of a Specified Database | hcloud RDS ListAuthorizedSqlserverDbUsers | Querying Authorized Users of a Specified Database | |
| Querying Details About Databases | hcloud RDS ListSqlserverDatabases | Querying Details About Databases | |
| Querying Details About Database Users | hcloud RDS ListSqlserverDbUsers | Querying Details About Database Users | |
| Modify Character Set | hcloud RDS ModifyCollation | Modify Character Set | |
| Revoking Permissions of a Database Account | hcloud RDS RevokeSqlserverDbUserPrivilege | Revoking Permissions of a Database Account | |
| Update statistics | hcloud RDS UpdateStatistics | Update statistics |
Event Center
Publications and Subscriptions (SQL Server)
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to modify subscriptions in batches for a DB instance | hcloud RDS BatchModifySubscription | This API is used to modify subscriptions in batches for a DB instance | |
| This API is used to query monitoring information of a DB instance's publication | hcloud RDS CollectPublicationMonitor | This API is used to query monitoring information of a DB instance's publication | |
| This API is used to query monitoring information of a DB instance's subscription | hcloud RDS CollectSubscriptionMonitor | This API is used to query monitoring information of a DB instance's subscription | |
| Creating a Scheduled Database Task Policy | hcloud RDS CreateJobSchedule | Creating a Scheduled Database Task Policy | |
| Create Release | hcloud RDS CreatePublication | Create Release | |
| Create subscriptions. | hcloud RDS CreateSubscription | Create subscriptions. | |
| This API is used to delete distributors of a DB instance | hcloud RDS DeleteDistribution | This API is used to delete distributors of a DB instance | |
| Deleting a Scheduled Database Task Policy | hcloud RDS DeleteJobSchedule | Deleting a Scheduled Database Task Policy | |
| This API is used to query the execution history of an agent job | hcloud RDS ListDbAgentJobHistorys | This API is used to query the execution history of an agent job | |
| This API is used to query the historical execution steps of an agent job for a DB instance | hcloud RDS ListDbAgentJobHistorySteps | This API is used to query the historical execution steps of an agent job for a DB instance | |
| This API is used to query agent jobs of a DB instance | hcloud RDS ListDbAgentJobs | This API is used to query agent jobs of a DB instance | |
| This API is used to query the distributors configured for a DB instance | hcloud RDS ListDistribution | This API is used to query the distributors configured for a DB instance | |
| This API is used to query instances that can be configured as distributors of the current instance | hcloud RDS ListDistributorInstances | This API is used to query instances that can be configured as distributors of the current instance | |
| Querying the Scheduled Task Policy of the Database | hcloud RDS ListJobSchedules | Querying the Scheduled Task Policy of the Database | |
| Query publications of a DB instance. | hcloud RDS ListPublications | Query publications of a DB instance. | |
| This API is used to query available publications for an RDS for SQL Server instance | hcloud RDS ListPublications4Subscription | This API is used to query available publications for an RDS for SQL Server instance | |
| This API is used to query publication and subscription profiles of a DB instance | hcloud RDS ListReplicationProfiles | This API is used to query publication and subscription profiles of a DB instance | |
| This API is used to query instances that can be configured as subscribers of the current instance | hcloud RDS ListSubscriberInstances | This API is used to query instances that can be configured as subscribers of the current instance | |
| This API is used to query subscriptions of a DB instance | hcloud RDS ListSubscriptions | This API is used to query subscriptions of a DB instance | |
| This API is used to modify an agent job for a DB instance | hcloud RDS ModifyDbAgentJob | This API is used to modify an agent job for a DB instance | |
| Modifying the Scheduled Task Policy of the Database | hcloud RDS ModifyJobSchedule | Modifying the Scheduled Task Policy of the Database | |
| Modify a publication | hcloud RDS ModifyPublication | Modify a publication | |
| This API is used to regenerate a publication snapshot for a DB instance | hcloud RDS RefreshPublicationSnapshot | This API is used to regenerate a publication snapshot for a DB instance | |
| This API is used to regenerate a subscription for a DB instance | hcloud RDS RefreshSubscription | This API is used to regenerate a subscription for a DB instance | |
| Restart Database Agent Job | hcloud RDS RestartDbAgentJob | Restart Database Agent Job | |
| This API is used to disable an agent job for a DB instance | hcloud RDS SwitchDbAgentJob | This API is used to disable an agent job for a DB instance | |
| This API is used to synchronize publication and subscription metadata | hcloud RDS SyncReplicationMetadata | This API is used to synchronize publication and subscription metadata | |
| login test | hcloud RDS ValidateInstanceConnection | login test |
Backup and Restoration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Database level point-in-time recovery | hcloud RDS BatchRestoreDatabase | Database level point-in-time recovery | |
| Table level point-in-time recovery(PostgreSQL) | hcloud RDS BatchRestorePostgreSqlTables | Table level point-in-time recovery(PostgreSQL) | |
| Backup Configuration | hcloud RDS ChangeBackupConfig | Backup Configuration | |
| Creating a Manual Backup | hcloud RDS CreateManualBackup | Creating a Manual Backup | |
| Restoring Data to a New DB Instance | hcloud RDS CreateRestoreInstance | Restoring Data to a New DB Instance | |
| Choose whether to retain automated backups when deleting an instance | hcloud RDS DeleteBackupSelection | Choose whether to retain automated backups when deleting an instance | |
| Deleting a Manual Backup | hcloud RDS DeleteManualBackup | Deleting a Manual Backup | |
| Obtaining Details About Backups | hcloud RDS ListBackups | Obtaining Details About Backups | |
| Querying Transfer Tasks | hcloud RDS ListBackupTransfers | Querying Transfer Tasks | |
| Query the recoverable libraries at a specified point in time | hcloud RDS ListHistoryDatabase | Query the recoverable libraries at a specified point in time | |
| Listing Instance Backup Summaries | hcloud RDS ListInstanceBackupSummary | Listing Instance Backup Summaries | |
| Checking Whether Fast Restoration Can Be Used for Restoring Databases or Tables (RDS for MySQL) | hcloud RDS ListInstancesSupportFastRestore | Checking Whether Fast Restoration Can Be Used for Restoring Databases or Tables (RDS for MySQL) | |
| Querying Details About Cross-Region Backups | hcloud RDS ListOffSiteBackups | Querying Details About Cross-Region Backups | |
| Querying Details About DB Instances for Which Cross-Region Backups Are Created | hcloud RDS ListOffSiteInstances | Querying Details About DB Instances for Which Cross-Region Backups Are Created | |
| Querying the Restoration Time Range of a Cross-Region Backup | hcloud RDS ListOffSiteRestoreTimes | Querying the Restoration Time Range of a Cross-Region Backup | |
| list packlog infos. | hcloud RDS ListPackLogInfos | list packlog infos. | |
| Query tables that can be restored at a specified point in time(PostgreSQL) | hcloud RDS ListPostgresqlListHistoryTables | Query tables that can be restored at a specified point in time(PostgreSQL) | |
| Querying the Restoration Time Range | hcloud RDS ListRestoreTimes | Querying the Restoration Time Range | |
| Querying a Shared Backup List | hcloud RDS ListShareBackups | Querying a Shared Backup List | |
| Query sparse backup policies | hcloud RDS ListSparseBackupPolicy | Query sparse backup policies | |
| list backup enhance policies | hcloud RDS ListUpdateBackupEnhancePolicy | list backup enhance policies | |
| Restoring Data to an Existing DB Instance | hcloud RDS RestoreExistInstance | Restoring Data to an Existing DB Instance | |
| Restoring Tables to a Specified Point in Time (MySQL) | hcloud RDS RestoreTables | Restoring Tables to a Specified Point in Time (MySQL) | |
| Restoring Tables to a Specified Point in Time (MySQL) | hcloud RDS RestoreTablesNew | Restoring Tables to a Specified Point in Time (MySQL) | |
| Restoring Data to an Existing DB Instance | hcloud RDS RestoreToExistingInstance | Restoring Data to an Existing DB Instance | |
| Configuring an Automated Backup Policy | hcloud RDS SetBackupPolicy | Configuring an Automated Backup Policy | |
| Setting a Cross-Region Backup Policy | hcloud RDS SetOffSiteBackupPolicy | Setting a Cross-Region Backup Policy | |
| Configuring an Automatic Transfer Policy | hcloud RDS SetTransferPolicy | Configuring an Automatic Transfer Policy | |
| query backup configuration | hcloud RDS ShowBackupConfig | query backup configuration | |
| Obtaining the Link for Downloading a Backup File | hcloud RDS ShowBackupDownloadLink | Obtaining the Link for Downloading a Backup File | |
| Querying an Automated Backup Policy | hcloud RDS ShowBackupPolicy | Querying an Automated Backup Policy | |
| Querying Backup Usage Overview | hcloud RDS ShowBackupUsage | Querying Backup Usage Overview | |
| Querying Databases Contained in a Database-Level Backup | hcloud RDS ShowDatabaseLevelDatabase | Querying Databases Contained in a Database-Level Backup | |
| show incremental backup policy | hcloud RDS ShowIncreBackupPolicy1 | show incremental backup policy | |
| Querying Information About a Cross-Region Backup Policy | hcloud RDS ShowOffSiteBackupPolicy | Querying Information About a Cross-Region Backup Policy | |
| Querying Automatic Transfer Policies | hcloud RDS ShowTransferPolicy | Querying Automatic Transfer Policies | |
| stop backup | hcloud RDS StopBackup | stop backup | |
| Transferring Backups to an OBS Bucket | hcloud RDS TransferBackup | Transferring Backups to an OBS Bucket | |
| update incremental backup policy | hcloud RDS UpdateIncreBackupPolicy1 | update incremental backup policy | |
| Modify the sparse backup policies of an instance | hcloud RDS UpdateSparseBackupPolicy | Modify the sparse backup policies of an instance |
Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Adding Tags in Batches | hcloud RDS BatchTagAddAction | Adding Tags in Batches | |
| Deleting Tags in Batches | hcloud RDS BatchTagDelAction | Deleting Tags in Batches | |
| Querying Instance Tags | hcloud RDS ListInstanceTags | Querying Instance Tags | |
| Querying Project Tags | hcloud RDS ListProjectTags | Querying Project Tags |
Database Proxy (PostgreSQL)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Changing the Instance Class of a DB Proxy Instance | hcloud RDS ChangeProxyScale | Changing the Instance Class of a DB Proxy Instance | |
| Changing the Delay Threshold of Read/Write Splitting | hcloud RDS ChangeTheDelayThreshold | Changing the Delay Threshold of Read/Write Splitting | |
| Querying Available Instance Classes for a DB Proxy Instance | hcloud RDS SearchQueryScaleComputeFlavors | Querying Available Instance Classes for a DB Proxy Instance | |
| Querying Available Instance Classes for a DB Proxy Instance | hcloud RDS SearchQueryScaleFlavors | Querying Available Instance Classes for a DB Proxy Instance | |
| Querying Information About Database Proxy | hcloud RDS ShowInformationAboutDatabaseProxy | Querying Information About Database Proxy | |
| Enabling Database Proxy | hcloud RDS StartDatabaseProxy | Enabling Database Proxy | |
| Disabling Database Proxy | hcloud RDS StopDatabaseProxy | Disabling Database Proxy | |
| Modifying Read Weight | hcloud RDS UpdateReadWeight | Modifying Read Weight |
Parameter Configuration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Comparing Parameter Templates | hcloud RDS CompareConfiguration | Comparing Parameter Templates | |
| Creating a Parameter Template | hcloud RDS CreateConfiguration | Creating a Parameter Template | |
| Deleting a Parameter Template | hcloud RDS DeleteConfiguration | Deleting a Parameter Template | |
| Applying a Parameter Template | hcloud RDS EnableConfiguration | Applying a Parameter Template | |
| Query Parameter Group Application History | hcloud RDS ListConfigurationApplyHistories | Query Parameter Group Application History | |
| Obtaining a Parameter Template List | hcloud RDS ListConfigurations | Obtaining a Parameter Template List | |
| Query the instance list of application parameter templates | hcloud RDS ListInstancesConfigurations | Query the instance list of application parameter templates | |
| Reset Custom Parameter Template | hcloud RDS ResetConfiguration | Reset Custom Parameter Template | |
| Obtaining Parameters of a Specified Parameter Template | hcloud RDS ShowConfiguration | Obtaining Parameters of a Specified Parameter Template | |
| Obtaining the Parameter Template of a Specified DB Instance | hcloud RDS ShowInstanceConfiguration | Obtaining the Parameter Template of a Specified DB Instance | |
| Modifying a Parameter Template | hcloud RDS UpdateConfiguration | Modifying a Parameter Template | |
| Modifying Parameters of a Specified DB Instance | hcloud RDS UpdateInstanceConfiguration | Modifying Parameters of a Specified DB Instance |
RDS
| API Name | Command | Description | Operation |
|---|---|---|---|
| intelligent kill session | hcloud RDS CreateIntelligentKillSession | intelligent kill session | |
| To query the diagnosis data of a table without an index | hcloud RDS GetInstancesNoIndexTables | To query the diagnosis data of a table without an index | |
| Trigger Audit Log Rotation | hcloud RDS RotateAuditLog | Trigger Audit Log Rotation | |
| Query automatic alarm list | hcloud RDS ShowAutoCesAlarm | Query automatic alarm list | |
| query intelligent kill session history | hcloud RDS ShowIntelligentKillSessionHistory | query intelligent kill session history | |
| query intelligent kill session statistic | hcloud RDS ShowIntelligentKillSessionStatistic | query intelligent kill session statistic |
Database Proxy (MySQL)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Proxy Instance | hcloud RDS CreateRdSforMySqlProxy | Creating a Proxy Instance | |
| Deleting a Proxy Instance | hcloud RDS DeleteRdSforMySqlProxy | Deleting a Proxy Instance | |
| Querying Proxy Instances | hcloud RDS ListRdSforMySqlProxy | Querying Proxy Instances | |
| Querying Proxy Instance Specifications | hcloud RDS ListRdSforMysqlProxyFlavors | Querying Proxy Instance Specifications | |
| Changing the Routing Policy of a Proxy Instance | hcloud RDS ModifyRdSforMySqlProxyRouteMode | Changing the Routing Policy of a Proxy Instance | |
| Restart the database proxy | hcloud RDS SetInstancesProxyRestart | Restart the database proxy |
Get The FileDownLoad Message
| API Name | Command | Description | Operation |
|---|---|---|---|
| Get The FileDownLoad Message | hcloud RDS CreateXelLogDownload | Get The FileDownLoad Message |
DR Instances
| API Name | Command | Description | Operation |
|---|---|---|---|
| Interface for Removing the Instance DR Relationship | hcloud RDS DeleteDisasterRecovery | Interface for Removing the Instance DR Relationship | |
| Querying the DR Management List | hcloud RDS ListDrInfos | Querying the DR Management List | |
| Batch querying information about Dr Instances | hcloud RDS ListDrRelations | Batch querying information about Dr Instances | |
| Querying the Cross-Cloud DR Replication Status | hcloud RDS ShowDrReplicaStatus | Querying the Cross-Cloud DR Replication Status | |
| Promoting a DR Instance to the Primary DB Instance | hcloud RDS StartInstanceDrToMasterAction | Promoting a DR Instance to the Primary DB Instance | |
| Configuring the DR Capability for a Primary DB Instance | hcloud RDS StartInstanceMasterDrAction | Configuring the DR Capability for a Primary DB Instance | |
| Configuring the DR Capability for a DR Instance | hcloud RDS StartInstanceSlaveDrAction | Configuring the DR Capability for a DR Instance |
Task Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Delete instant task | hcloud RDS DeleteJob | Delete instant task | |
| Obtaining Information About a Task with a Specified ID | hcloud RDS ListJobInfo | Obtaining Information About a Task with a Specified ID | |
| Obtaining Task Information of a Specified SQL Server DB Instance in a Specified Time Range | hcloud RDS ListJobInfoDetail | Obtaining Task Information of a Specified SQL Server DB Instance in a Specified Time Range |
Log Information Queries
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to delete log config. | hcloud RDS DeleteLogLtsConfigs | This API is used to delete log config. | |
| Obtaining Links for Downloading Error Query Logs | hcloud RDS DownloadErrorlog | Obtaining Links for Downloading Error Query Logs | |
| Obtaining Links for Downloading Slow Query Logs | hcloud RDS DownloadSlowlog | Obtaining Links for Downloading Slow Query Logs | |
| Obtaining the Audit Log List | hcloud RDS ListAuditlogs | Obtaining the Audit Log List | |
| Querying Database Error Logs | hcloud RDS ListErrorLogs | Querying Database Error Logs | |
| Querying Database Error Logs | hcloud RDS ListErrorLogsNew | Querying Database Error Logs | |
| This API is used to list log config. | hcloud RDS ListLogLtsConfigs | This API is used to list log config. | |
| Querying Slow Query Log Files | hcloud RDS ListSlowLogFile | Querying Slow Query Log Files | |
| Querying Database Slow Logs | hcloud RDS ListSlowLogs | Querying Database Slow Logs | |
| Querying Database Slow Logs | hcloud RDS ListSlowLogsNew | Querying Database Slow Logs | |
| Obtaining Slow Query Log Statistics | hcloud RDS ListSlowlogStatistics | Obtaining Slow Query Log Statistics | |
| Setting a Policy for Audit Logs | hcloud RDS SetAuditlogPolicy | Setting a Policy for Audit Logs | |
| Setting the Local Retention Period of Binlogs | hcloud RDS SetBinlogClearPolicy | Setting the Local Retention Period of Binlogs | |
| This API is used to add log config. | hcloud RDS SetLogLtsConfigs | This API is used to add log config. | |
| Showing Original Logs | hcloud RDS SetSensitiveSlowLog | Showing Original Logs | |
| Obtaining the Link for Downloading an Audit Log | hcloud RDS ShowAuditlogDownloadLink | Obtaining the Link for Downloading an Audit Log | |
| Querying the Policy for SQL Audit Logs | hcloud RDS ShowAuditlogPolicy | Querying the Policy for SQL Audit Logs | |
| Obtaining the Local Retention Period of Binlogs | hcloud RDS ShowBinlogClearPolicy | Obtaining the Local Retention Period of Binlogs |
API Versions
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying API Versions | hcloud RDS ListApiVersion | Querying API Versions | |
| Querying API Versions | hcloud RDS ListApiVersionNew | Querying API Versions | |
| Querying a Specified API Version | hcloud RDS ShowApiVersion | Querying a Specified API Version |
DB Engine Versions and Specifications
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Version Information About a DB Engine | hcloud RDS ListDatastores | Querying Version Information About a DB Engine | |
| Querying Database Specifications | hcloud RDS ListFlavors | Querying Database Specifications | |
| Querying the Storage Type of a Database | hcloud RDS ListStorageTypes | Querying the Storage Type of a Database |
Logs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Error Logs Through LTS | hcloud RDS ListErrorlogForLts | Querying Error Logs Through LTS | |
| Querying Slow Query Logs Through LTS | hcloud RDS ListSlowlogForLts | Querying Slow Query Logs Through LTS | |
| Querying Slow Query Log Statistics | hcloud RDS ListSlowLogStatisticsForLts | Querying Slow Query Log Statistics |
Recycle Bin
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Instances in the Recycle Bin | hcloud RDS ListRecycleInstances | Querying Instances in the Recycle Bin | |
| Querying the Recycling Policy | hcloud RDS ShowRecyclePolicy | Querying the Recycling Policy | |
| Modifying Recycling Policy | hcloud RDS StartRecyclePolicy | Modifying Recycling Policy |
Check version
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Minor Version Number | hcloud RDS ListSmallVersion | Querying the Minor Version Number |
SQL statistics
get the xelLogFileList
| API Name | Command | Description | Operation |
|---|---|---|---|
| get the xelLogFileList | hcloud RDS ListXellogFiles | get the xelLogFileList |
Database Security
| API Name | Command | Description | Operation |
|---|---|---|---|
| Changing a Security Group | hcloud RDS SetSecurityGroup | Changing a Security Group | |
| Configuring SSL | hcloud RDS SwitchSsl | Configuring SSL | |
| Changing the Floating IP Address of a DB Instance | hcloud RDS UpdateDataIp | Changing the Floating IP Address of a DB Instance | |
| Changing a Database Port | hcloud RDS UpdatePort | Changing a Database Port |
hot/cold data separation
| API Name | Command | Description | Operation |
|---|---|---|---|
| Checking whether cold and hot data separation is enabled | hcloud RDS ShowHotClodSeparationStatus | Checking whether cold and hot data separation is enabled |
Msdtc
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtain local MSDTC information | hcloud RDS ShowMsdtcLocalHost | Obtain local MSDTC information |
Quota Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Quotas | hcloud RDS ShowQuotas | Querying Quotas |
Configure Readonly Replay Delay (PostgreSQL)
| API Name | Command | Description | Operation |
|---|---|---|---|
| query wal log recovery time window | hcloud RDS ShowRecoveryTimeWindow | query wal log recovery time window | |
| show wal log replay delay status | hcloud RDS ShowReplayDelayStatus | show wal log replay delay status | |
| pause/resume wal replay | hcloud RDS SwitchLogReplay | pause/resume wal replay |
Obtaining Task Information
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Task Information | hcloud RDS ShowTaskDetail | Obtaining Task Information |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
