# API Index

## 

| API | Description Information |
|:---|:---|
|[DescribeUDBLogBackupURL](udb-api/describe_udb_log_backup_url)|Obtain the log backup address of UDB|
|[SwitchUDBInstanceToHA](udb-api/switch_udb_instance_to_ha)|Switch from General UDB to High Availability|
|[CheckUDBInstanceToHAAllowance](udb-api/check_udb_instance_to_ha_allowance)|Check if the db can be upgraded to high availability|
|[PromoteUDBSlave](udb-api/promote_udb_slave)|Promote from Slave|
|[DescribeUDBBinlogBackupURL](udb-api/describe_udb_binlog_backup_url)|(New) Get the log backup address of UDB|
|[DescribeUDBInstanceBinlog](udb-api/describe_udb_instance_binlog)||
|[DescribeUDBBackupBlacklist](udb-api/describe_udb_backup_blacklist)||
|[FetchUDBInstanceEarliestRecoverTime](udb-api/fetch_udb_instance_earliest_recover_time)|Get the earliest possible rollback time|
|[CheckRecoverUDBInstance](udb-api/check_recover_udb_instance)|Check if the db can use the rollback function|
|[EditUDBBackupBlacklist](udb-api/edit_udb_backup_blacklist)|Edit Backup Blacklist|
|[SwitchUDBHAToSentinel](udb-api/switch_udb_ha_to_sentinel)|UDB High Availability instance upgraded to Sentinel version (without HAProxy), upgrade takes 5-10 seconds|
|[BackupUDBInstanceSlowLog](udb-api/backup_udb_instance_slow_log)|Backup analysis results of slowlog for a specified time period in UDB|
|[BackupUDBInstanceBinlog](udb-api/backup_udb_instance_binlog)|Backup UDB binlog list for a specified time period|
|[CreateUDBInstanceByRecovery](udb-api/create_udb_instance_by_recovery)|Restore the newly created db to a specified point in time in the specified db.|
|[UpdateUDBInstanceSlaveBackupSwitch](udb-api/update_udb_instance_slave_backup_switch)|Enable or disable UDB slave backup|
|[PromoteUDBInstanceToHA](udb-api/promote_udb_instance_to_ha)|Upgrade regular db to high availability|
|[CreateUDBSlave](udb-api/create_udb_slave)|Create Slave|
|[EnableUDBRWSplitting](udb-api/enable_udb_rw_splitting)|Enable read-write separation function|
|[DisableUDBRWSplitting](udb-api/disable_udb_rw_splitting)|Turn off read-write separation function|
|[RestartRWSplitting](udb-api/restart_rw_splitting)|Read-Write Splitting Middleware Restart|
|[SetUDBRWSplitting](udb-api/set_udb_rw_splitting)|Set up Read-Write Splitting|

## 

| API | Description Information |
|:---|:---|
|[CreateUDBRouteInstance](udb-api/create_udb_route_instance)|Create mongos instance|
|[CreateMongoDBReplicaSet](udb-api/create_mongo_db_replica_set)|Create DB Replica Set|
|[CreateUDBReplicationInstance](udb-api/create_udb_replication_instance)|Create Replica|

## 

| API | Description Information |
|:---|:---|
|[DescribeUDBInstance](udb-api/describe_udb_instance)|Get UDB Information|
|[DescribeUDBInstancePrice](udb-api/describe_udb_instance_price)|Get UDB Price|
|[ClearUDBLog](udb-api/clear_udb_log)|Clear Log|
|[RestartUDBInstance](udb-api/restart_udb_instance)|Restart UDB|
|[ResizeUDBInstance](udb-api/resize_udb_instance)|Modify the configuration of the UDB instance|
|[ChangeUDBParamGroup](udb-api/change_udb_param_group)|Modify Configuration File|
|[DescribeUDBInstanceLog](udb-api/describe_udb_instance_log)|Retrieve UDB error logs or slow query logs|
|[DescribeUDBLogPackage](udb-api/describe_udb_log_package)|List UDB Instance Log Backup Information|
|[DescribeUDBInstanceState](udb-api/describe_udb_instance_state)|Get UDB status|
|[DescribeUDBInstanceBackupState](udb-api/describe_udb_instance_backup_state)|Get instance backup status|
|[ModifyUDBInstanceName](udb-api/modify_udb_instance_name)|Modify UDB Name|
|[StartUDBInstance](udb-api/start_udb_instance)|Start UDB|
|[ModifyUDBInstancePassword](udb-api/modify_udb_instance_password)|Change the administrator password of the DB instance|
|[ExtractUDBParamGroup](udb-api/extract_udb_param_group)|Get configuration file content|
|[DescribeUDBType](udb-api/describe_udb_type)|Get the supported types of UDB|
|[StopUDBInstance](udb-api/stop_udb_instance)|Turn off UDB|
|[DeleteUDBInstance](udb-api/delete_udb_instance)|Delete UDB|
|[BackupUDBInstance](udb-api/backup_udb_instance)|Backup UDB|
|[DescribeUDBInstanceBinlogBackupState](udb-api/describe_udb_instance_binlog_backup_state)|Get UDB instance backup status|
|[DeleteUDBParamGroup](udb-api/delete_udb_param_group)|Delete Configuration|
|[DescribeUDBInstanceBackupURL](udb-api/describe_udb_instance_backup_url)|Get UDB backup download address|
|[CreateUDBInstance](udb-api/create_udb_instance)|Create Database|
|[UpdateUDBInstanceBackupStrategy](udb-api/update_udb_instance_backup_strategy)|Modify UDB Auto Backup Strategy|
|[BackupUDBInstanceErrorLog](udb-api/backup_udb_instance_error_log)|Backup UDB errorlog for a specified time period|
|[UploadUDBParamGroup](udb-api/upload_udb_param_group)|Import Configuration|
|[DeleteUDBLogPackage](udb-api/delete_udb_log_package)|Delete UDB Log Package|
|[CreateUDBParamGroup](udb-api/create_udb_param_group)|Create Configuration File|
|[DescribeUDBParamGroup](udb-api/describe_udb_param_group)|Get Parameter Information|
|[DescribeUDBBackup](udb-api/describe_udb_backup)|Get Backup List|
|[UpdateUDBParamGroup](udb-api/update_udb_param_group)|Update Configuration|
|[DescribeUDBInstanceUpgradePrice](udb-api/describe_udb_instance_upgrade_price)|Get UDB instance upgrade/downgrade price information|

## 

| API | Description Information |
|:---|:---|
|[CreateUDBMySQLInstance](udb-api/create_udb_my_sql_instance)|create mysql instance|
|[CreateUDBSQLServerInstance](udb-api/create_udb_sql_server_instance)|Create an SQL Server database|
|[DescribeUDBBackupStrategy](udb-api/describe_udb_backup_strategy)|DescribeUDBBackupStrategy|
|[DescribeUDBBinlogBackup](udb-api/describe_udb_binlog_backup)|DescribeUDBBinlogBackup|
|[DescribeUDBBinlogBackupStrategy](udb-api/describe_udb_binlog_backup_strategy)|Get the binlog automatic backup policy of a UDB instance.|
|[DescribeUDBSplittingInfo](udb-api/describe_udb_splitting_info)|Describe Read-Write Splitting Function|
|[GetUDBClientConnNum](udb-api/get_udb_client_conn_num)|Get connection instance client IP and number of connections|
|[GetUDBInstanceSSLCertURL](udb-api/get_udb_instance_ssl_cert_url)|Get SSL Certificate Download Address|
|[ListUDBInstanceFailoverRecord](udb-api/list_udb_instance_failover_record)|ListUDBInstanceFailoverRecord|
|[ListUDBMachineType](udb-api/list_udb_machine_type)|Get UDB Cloud Database Compute Specification List|
|[ListUDBUserTables](udb-api/list_udb_user_tables)|View the user table collection of UDB instances|
|[ModifyUDBInstanceRemarkName](udb-api/modify_udb_instance_remark_name)|Modify UDB Remark|
|[ModifyUDBInstanceSSL](udb-api/modify_udb_instance_ssl)|Adjust SSL Information|
|[RollbackUDBInstance](udb-api/rollback_udb_instance)|Rollback Specified Database Table|
|[UpgradeUDBInstanceToHA](udb-api/upgrade_udb_instance_to_ha)|Upgrade QuickJ normal db to high availability|
|[UpgradeUDBVersion](udb-api/upgrade_udb_version)|Upgrade db instance version|