# API 索引

## MySQL

| API | 描述信息 |
|:---|:---|
|[DescribeUDBLogBackupURL](udb-api/describe_udb_log_backup_url)|获取UDB的日志备份地址|
|[SwitchUDBInstanceToHA](udb-api/switch_udb_instance_to_ha)|普通UDB切换为高可用|
|[CheckUDBInstanceToHAAllowance](udb-api/check_udb_instance_to_ha_allowance)|核查db是否可以升级为高可用|
|[PromoteUDBSlave](udb-api/promote_udb_slave)|提升从库|
|[DescribeUDBBinlogBackupURL](udb-api/describe_udb_binlog_backup_url)|(新)获取UDB的日志备份地址|
|[DescribeUDBInstanceBinlog](udb-api/describe_udb_instance_binlog)|获取UDBbinlog列表|
|[DescribeUDBBackupBlacklist](udb-api/describe_udb_backup_blacklist)|获取备份黑名单|
|[FetchUDBInstanceEarliestRecoverTime](udb-api/fetch_udb_instance_earliest_recover_time)|获取最早可回档时间|
|[CheckRecoverUDBInstance](udb-api/check_recover_udb_instance)|核查db是否可以使用回档功能|
|[EditUDBBackupBlacklist](udb-api/edit_udb_backup_blacklist)|编辑备份黑名单|
|[SwitchUDBHAToSentinel](udb-api/switch_udb_ha_to_sentinel)|UDB高可用实例升级为Sentinel版本（不带HAProxy）升级耗时5-10秒|
|[BackupUDBInstanceSlowLog](udb-api/backup_udb_instance_slow_log)|备份UDB指定时间段的slowlog分析结果|
|[BackupUDBInstanceBinlog](udb-api/backup_udb_instance_binlog)|备份UDB指定时间段的binlog列表|
|[CreateUDBInstanceByRecovery](udb-api/create_udb_instance_by_recovery)|将新建的db恢复到指定db某个指定时间点|
|[UpdateUDBInstanceSlaveBackupSwitch](udb-api/update_udb_instance_slave_backup_switch)|开启或者关闭UDB从库备份|
|[PromoteUDBInstanceToHA](udb-api/promote_udb_instance_to_ha)|普通db升级为高可用|
|[CreateUDBSlave](udb-api/create_udb_slave)|创建从库|
|[EnableUDBRWSplitting](udb-api/enable_udb_rw_splitting)|启用读写分离功能|
|[DisableUDBRWSplitting](udb-api/disable_udb_rw_splitting)|关闭读写分离功能|
|[RestartRWSplitting](udb-api/restart_rw_splitting)|读写分离中间件重启|
|[SetUDBRWSplitting](udb-api/set_udb_rw_splitting)|设置读写分离|

## MongoDB

| API | 描述信息 |
|:---|:---|
|[CreateUDBRouteInstance](udb-api/create_udb_route_instance)|创建mongos实例|
|[CreateMongoDBReplicaSet](udb-api/create_mongo_db_replica_set)|创建DB副本集|
|[CreateUDBReplicationInstance](udb-api/create_udb_replication_instance)|创建副本|

## 公共 API

| API | 描述信息 |
|:---|:---|
|[DescribeUDBInstance](udb-api/describe_udb_instance)|获取云数据库信息|
|[DescribeUDBInstancePrice](udb-api/describe_udb_instance_price)|获取云数据库价格|
|[ClearUDBLog](udb-api/clear_udb_log)|清除日志|
|[RestartUDBInstance](udb-api/restart_udb_instance)|重启云数据库|
|[ResizeUDBInstance](udb-api/resize_udb_instance)|修改UDB实例的配置|
|[ChangeUDBParamGroup](udb-api/change_udb_param_group)|修改配置文件|
|[DescribeUDBInstanceLog](udb-api/describe_udb_instance_log)|获取UDB错误日志或慢查询日志|
|[DescribeUDBLogPackage](udb-api/describe_udb_log_package)|列表UDB实例日志备份信息|
|[DescribeUDBInstanceState](udb-api/describe_udb_instance_state)|获取云数据库状态|
|[DescribeUDBInstanceBackupState](udb-api/describe_udb_instance_backup_state)|获取实例备份状态|
|[ModifyUDBInstanceName](udb-api/modify_udb_instance_name)|修改云数据库名称|
|[StartUDBInstance](udb-api/start_udb_instance)|启动云数据库|
|[ModifyUDBInstancePassword](udb-api/modify_udb_instance_password)|修改DB实例的管理员密码|
|[ExtractUDBParamGroup](udb-api/extract_udb_param_group)|获取配置文件内容|
|[DescribeUDBType](udb-api/describe_udb_type)|获取云数据库支持类型|
|[StopUDBInstance](udb-api/stop_udb_instance)|关闭云数据库|
|[DeleteUDBInstance](udb-api/delete_udb_instance)|删除云数据库|
|[BackupUDBInstance](udb-api/backup_udb_instance)|备份云数据库|
|[DescribeUDBInstanceBinlogBackupState](udb-api/describe_udb_instance_binlog_backup_state)|获取udb实例备份状态|
|[DeleteUDBParamGroup](udb-api/delete_udb_param_group)|删除配置|
|[DescribeUDBInstanceBackupURL](udb-api/describe_udb_instance_backup_url)|获取UDB备份下载地址|
|[CreateUDBInstance](udb-api/create_udb_instance)|创建数据库|
|[UpdateUDBInstanceBackupStrategy](udb-api/update_udb_instance_backup_strategy)|修改UDB自动备份策略|
|[BackupUDBInstanceErrorLog](udb-api/backup_udb_instance_error_log)|备份UDB指定时间段的errorlog|
|[UploadUDBParamGroup](udb-api/upload_udb_param_group)|导入配置|
|[DeleteUDBLogPackage](udb-api/delete_udb_log_package)|删除UDB日志包|
|[CreateUDBParamGroup](udb-api/create_udb_param_group)|创建配置文件|
|[DescribeUDBParamGroup](udb-api/describe_udb_param_group)|获取参数信息|
|[DescribeUDBBackup](udb-api/describe_udb_backup)|获取备份列表|
|[UpdateUDBParamGroup](udb-api/update_udb_param_group)|更新配置|
|[DescribeUDBInstanceUpgradePrice](udb-api/describe_udb_instance_upgrade_price)|获取UDB实例升降级价格信息|

## API

| API | 描述信息 |
|:---|:---|
|[CreateUDBMySQLInstance](udb-api/create_udb_my_sql_instance)|创建MySQL数据库|
|[CreateUDBSQLServerInstance](udb-api/create_udb_sql_server_instance)|创建SQLServer数据库|
|[DescribeUDBBackupStrategy](udb-api/describe_udb_backup_strategy)|获取实例备份策略|
|[DescribeUDBBinlogBackup](udb-api/describe_udb_binlog_backup)|列表UDB实例Binlog自动备份信息|
|[DescribeUDBBinlogBackupStrategy](udb-api/describe_udb_binlog_backup_strategy)|获取UDB实例binlog自动备份策略|
|[DescribeUDBSplittingInfo](udb-api/describe_udb_splitting_info)|描述读写分离功能|
|[GetUDBClientConnNum](udb-api/get_udb_client_conn_num)|获取连接实例客户端Ip和连接数|
|[GetUDBInstanceSSLCertURL](udb-api/get_udb_instance_ssl_cert_url)|获取SSL证书下载地址|
|[ListUDBInstanceFailoverRecord](udb-api/list_udb_instance_failover_record)|获取实例容灾记录列表|
|[ListUDBMachineType](udb-api/list_udb_machine_type)|获取UDB云数据库计算规格列表|
|[ListUDBUserTables](udb-api/list_udb_user_tables)|查看udb实例的用户表集合|
|[ModifyUDBInstanceRemarkName](udb-api/modify_udb_instance_remark_name)|修改云数据库备注|
|[ModifyUDBInstanceSSL](udb-api/modify_udb_instance_ssl)|调整SSL的信息|
|[RollbackUDBInstance](udb-api/rollback_udb_instance)|回档指定库表|
|[UpgradeUDBInstanceToHA](udb-api/upgrade_udb_instance_to_ha)|快杰普通db升级为高可用|
|[UpgradeUDBVersion](udb-api/upgrade_udb_version)|升级db实例版本|