本產品（
云數據庫 RDS/2014-08-15）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
費用
| API | 標題 | API概述 |
|---|---|---|
| TransformDBInstancePayType | 變更RDS實例的計費方式 | 該接口用于變更RDS實例的計費方式。 |
| ModifyDBInstancePayType | 按量付費實例轉包年包月 | 該接口用于將按量付費實例變更為包年包月實例。 |
| ModifyInstanceAutoRenewalAttribute | 修改RDS實例的自動續費設置 | 該接口用于修改RDS實例的自動續費設置。 |
| DescribePrice | 查詢實例的價格 | 該接口用于查詢RDS實例的價格信息。 |
| DescribeRenewalPrice | 查詢RDS實例續費的費用 | 該接口用于查詢包年包月RDS實例續費的費用。 |
| DescribeInstanceAutoRenewalAttribute | 查詢RDS實例自動續費情況 | 該接口用于查詢RDS實例自動續費情況。 |
| RenewInstance | 手動續費RDS實例 | 該接口用于為RDS實例手動續費。 |
實例
| API | 標題 | API概述 |
|---|---|---|
| CreateDBInstance | 創建一個RDS實例 | 該接口用于創建RDS實例。 |
| CreateDBInstanceForRebuild | 回收站重建實例 | 該接口用于重建已進入回收站的實例。 |
| DeleteDBInstance | 釋放RDS實例 | 該接口用于釋放RDS實例。 |
| RestartDBInstance | 重啟RDS實例 | 該接口用于手動重啟RDS實例。 |
| ModifyDBInstanceSpec | 變更RDS實例 | 該接口用于變更RDS實例的規格和存儲空間等。 |
| ModifyDBInstanceDescription | 修改實例名稱 | 該接口用于修改RDS實例的名稱。 |
| ModifyDBInstanceMaintainTime | 修改實例可維護時間段 | 該接口用于修改RDS實例的可維護時間段。 |
| ModifyResourceGroup | 修改實例資源組 | 該接口用于將RDS實例移動到指定資源組。 |
| ModifyHADiagnoseConfig | 修改實例可用性檢測方式 | 該接口用于修改RDS實例的可用性檢測方式。 |
| DescribeAvailableZones | 查詢可用區資源 | 該接口用于查詢RDS的可用區資源。 |
| DescribeAvailableClasses | 查詢實例可變更規格 | 該接口用于查詢RDS實例的可變更規格及存儲空間等信息。 |
| DescribeDBInstanceAttribute | 查詢實例詳情 | 該接口用于查詢RDS實例的詳細信息。 |
| DescribeDBInstances | 查詢實例列表 | 該接口用于查詢RDS的實例列表。 |
| ListClasses | 查詢規格信息 | 該接口用于查詢RDS實例所有規格的詳情。 |
| DescribeDBInstancesByExpireTime | 按過期時間獲取數據庫實例 | 該接口用于通過包年包月實例的剩余可用時間查詢RDS實例信息。 |
| DescribeRegions | 查看可選的地域和可用區 | 該接口用于查詢所有RDS地域和可用區詳情（包含已裁撤地域，請謹慎使用）。 |
| CheckInstanceExist | 查詢實例是否存在 | 該接口用于查詢目標RDS實例是否存在。 |
| DescribeHADiagnoseConfig | 查詢實例可用性檢測方式 | 該接口用于查詢RDS實例的可用性檢測方式。 |
| CheckCloudResourceAuthorized | 查詢RDS實例的授權狀態 | 該接口用于查詢RDS實例的權限狀態。 |
| ReleaseInstanceConnection | 釋放實例外網連接地址 | 該接口用于釋放RDS實例的外網連接地址。 |
網絡與連接地址
| API | 標題 | API概述 |
|---|---|---|
| AllocateInstancePublicConnection | 申請外網連接地址 | 該接口用于為RDS實例申請外網連接地址。 |
| ReleaseInstancePublicConnection | 釋放實例的外網連接地址 | 該接口用于釋放實例的外網連接地址。 |
| ModifyDBInstanceConnectionString | 修改實例的連接地址和端口 | 該接口用于修改實例的連接地址和端口。 |
| DescribeDBInstanceNetInfo | 查詢實例的所有連接地址信息 | 該接口用于查詢RDS實例的所有連接地址信息。 |
| DescribeVSwitches | 查詢虛擬交換機列表 | 該接口用于查詢專有網絡VPC下虛擬交換機的詳細信息。 |
主備高可用和數據復制方式
| API | 標題 | API概述 |
|---|---|---|
| ModifyHASwitchConfig | 開啟或關閉RDS實例的主備自動切換功能 | 該接口用于開啟或關閉RDS實例的主備自動切換功能。 |
| DescribeHASwitchConfig | 查詢RDS實例主備自動切換設置 | 該接口用于查詢RDS實例主備自動切換的設置。 |
| SwitchDBInstanceHA | RDS實例主備切換 | 該接口用于RDS實例的手動主備切換。 |
歷史事件
| API | 標題 | API概述 |
|---|---|---|
| ModifyActionEventPolicy | 開關歷史事件 | 該接口用于開啟或關閉RDS的歷史事件功能。 |
| DescribeEvents | 查詢歷史事件 | 該接口用于查詢RDS歷史事件記錄列表。 |
| DescribeActionEventPolicy | 查詢RDS歷史事件功能是否開啟 | 該接口用于查詢RDS的歷史事件功能是否開啟。 |
通知
| API | 標題 | API概述 |
|---|---|---|
| QueryNotify | 查詢通知 | 該接口用于查詢RDS的通知。 |
| ConfirmNotify | 確認通知 | 該接口用于確認主賬號下RDS控制臺的輪播消息。 |
賬號
| API | 標題 | API概述 |
|---|---|---|
| CreateAccount | 創建數據庫賬號 | 該接口用于創建數據庫賬號。 |
| DeleteAccount | 刪除數據庫賬號 | 該接口用于刪除數據庫賬號。 |
| ModifyAccountDescription | 修改數據庫賬號的備注信息 | 該接口用于修改數據庫賬號的描述信息。 |
| DescribeAccounts | 查詢數據庫賬號信息 | 該接口用于查詢RDS實例的賬號信息。 |
| DescribeInstanceKeywords | 獲取實例的保留關鍵詞信息 | 該接口用于查詢RDS實例的保留關鍵字，即創建數據庫或賬號時禁用的關鍵字。 |
| ResetAccountPassword | 重置數據庫賬號的密碼 | 該接口用于重置數據庫賬號的密碼。 |
| GrantAccountPrivilege | 授權賬號訪問數據庫 | 該接口用于授權數據庫賬號訪問指定的數據庫。 |
| RevokeAccountPrivilege | 撤銷賬號對數據庫的訪問權限 | 該接口用于撤銷賬號對數據庫的訪問權限。 |
| ResetAccount | 重置高權限賬號權限 | 該接口用于重置高權限賬號的權限。 |
| CheckAccountNameAvailable | 檢查賬號名稱是否可用 | 該接口用于檢查目標需要創建的賬號名稱是否可用。 |
數據庫
| API | 標題 | API概述 |
|---|---|---|
| CreateDatabase | 創建數據庫 | 該接口用于在RDS實例下創建數據庫。 |
| DeleteDatabase | 刪除數據庫 | 該接口用于刪除RDS實例下的指定數據庫。 |
| ModifyDBDescription | 修改數據庫備注說明 | 該接口用于修改數據庫的備注。 |
| DescribeDatabases | 查看實例下的數據庫信息 | 該接口用于查詢RDS實例下的數據庫信息。 |
| DescribeCharacterSetName | 查看數據庫支持的字符集列表 | 該接口用于查詢RDS實例支持的字符集。 |
| CheckDBNameAvailable | 檢查數據庫名稱是否可用 | 該接口用于檢查數據庫名稱是否重復或不符合命名規范。 |
安全加密
| API | 標題 | API概述 |
|---|---|---|
| ModifySecurityIps | 修改RDS實例IP白名單 | 該接口用于修改RDS實例的IP白名單。 |
| ModifyDBInstanceDeletionProtection | 開啟或關閉實例釋放保護 | 該接口用于開啟或關閉RDS實例的釋放保護功能。 |
| DescribeDBInstanceIPArrayList | 查看RDS實例IP白名單 | 該接口用于查詢RDS實例的IP白名單。 |
日志
| API | 標題 | API概述 |
|---|---|---|
| DescribeSlowLogs | 查看慢日志統計情況 | 該接口用于查詢慢日志統計情況。 |
| DescribeSlowLogRecords | 查看慢日志明細 | 該接口用于查看實例的慢日志明細。 |
| DescribeErrorLogs | 查看錯誤日志 | 該接口查詢實例某段時間內的錯誤日志。 |
| DescribeSQLLogReportList | 獲取SQL日志報告列表 | 該接口用于查看SQL日志運行報告列表。 |
備份
| API | 標題 | API概述 |
|---|---|---|
| CreateBackup | 為RDS實例創建備份集 | 該接口用于為RDS實例創建一個備份集。 |
| ModifyBackupPolicy | 修改實例備份策略 | 該接口用于修改RDS實例的備份策略設置。 |
| DescribeBackups | 查看RDS實例備份集列表 | 該接口用于查看RDS實例的備份集列表。 |
| DescribeBackupPolicy | 查看實例備份設置 | 該接口用于查詢RDS實例的備份設置。 |
| DescribeBackupTasks | 查詢實例的備份任務列表 | 該接口用于查詢RDS實例的備份任務列表。 |
| DescribeBinlogFiles | 查看RDS實例的日志（Binglog/Wal）文件 | 該接口用于查詢RDS MySQL/RDS MariaDB實例的Binlog日志或RDS PostgreSQL實例的Wal日志。 |
恢復
| API | 標題 | API概述 |
|---|---|---|
| DescribeLocalAvailableRecoveryTime | 查詢RDS實例備份可恢復的時間范圍 | 該接口用于查詢RDS實例備份可恢復的時間范圍。 |
| CloneDBInstance | 恢復數據（克隆實例） | 該接口用于將歷史數據恢復至一個新實例（稱為克隆實例）。 |
監控
| API | 標題 | API概述 |
|---|---|---|
| DescribeResourceUsage | 查看實例的空間利用信息 | 該接口用于查詢RDS實例的空間使用信息。 |
| DescribeDBInstancePerformance | 查詢實例性能數據 | 該接口用于查詢實例性能數據。 |
| DescribeDBInstanceMonitor | 查詢監控頻率 | 該接口用于查詢監控頻率。 |
參數
| API | 標題 | API概述 |
|---|---|---|
| ModifyParameter | 修改實例參數 | 該接口用于修改RDS實例的參數值。 |
| DescribeParameters | 查詢實例當前的參數配置 | 該接口用于查詢實例當前的參數配置。 |
| DescribeModifyParameterLog | 查詢RDS實例的參數修改日志 | 該接口用于查詢RDS實例的參數修改日志。 |
| DescribeParameterTemplates | 查看參數模板詳情列表 | 該接口用于查詢數據庫參數模板。 |
運維任務管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyActiveOperationTasks | 修改多個主動運維任務切換時間 | 該接口用于修改RDS實例計劃內運維任務的切換時間。 |
| DescribeActiveOperationTasks | 查詢多個主動運維任務信息 | 該接口用于查看RDS實例的計劃內運維任務詳情。 |
| CancelActiveOperationTasks | 取消主動運維任務 | 該接口用于取消尚未開始的運維任務。 |
標簽
| API | 標題 | API概述 |
|---|---|---|
| TagResources | 創建標簽 | 該接口用于為指定的RDS實例創建并綁定標簽。 |
| AddTagsToResource | 為實例綁定標簽 | 該接口用于為實例綁定標簽。 |
| UntagResources | 解綁標簽 | 該接口用于為指定的RDS實例解綁標簽。 |
| RemoveTagsFromResource | 為RDS實例解綁標簽 | 該接口用于解綁標簽。 |
| ListTagResources | 查詢標簽和資源列表 | 該接口用于查詢一個或多個RDS實例已經綁定的標簽列表。 |
| DescribeTags | 查詢標簽列表 | 該接口用于查詢RDS實例的標簽信息。 |
| DescribeDBInstanceByTags | 查詢實例標簽信息 | 該接口用于獲取實例綁定的標簽信息。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| DescribeRegionInfos | 查詢可見地域列表 | 該接口用于獲取地域列表。 |
| DescribeDBInstanceNetInfoForChannel | 查詢實例網絡信息 | 該接口用于查詢RDS實例的所有連接地址信息。 |
| DescribeClassDetails | 查詢規格詳情 | 該接口用于通過規格代碼查詢規格詳情。 |
| DescribeKmsAssociateResources | 查詢KMS指定資源是否關聯RDS實例 | 該接口用于查詢KMS的指定資源是否關聯了RDS實例。 |
| DeleteReplicationLink | 刪除災備實例的數據同步鏈路并將其提升為主實例 | 該接口用于刪除RDS災備實例的數據同步鏈路，并將其提升為主實例。 |
| DescribeReplicationLinkLogs | 查詢RDS實例數據同步鏈路的操作日志 | 該接口用于查詢指定RDS實例數據同步鏈路的操作日志。 |
| CreateReplicationLink | 創建災備實例 | 該接口用于為RDS實例創建災備實例，并配置數據同步鏈路。 |
| RebuildReplicationLink | 為災備實例重建數據同步鏈路 | 該接口用于為RDS災備實例重建數據同步鏈路。 |
停止維護的接口
| API | 標題 | API概述 |
|---|---|---|
| 數據庫性能優化 | 數據庫性能優化 | |
| DescribeDiagnosticReportList | 查詢診斷報告列表 | 該接口用于查詢診斷報告列表。 |
| DestroyDBInstance | 銷毀實例 | 該接口用于銷毀回收站中的RDS實例。 |
| DescribeTasks | 查詢遷移結果 | 調用DescribeTasks接口查詢RDS實例正在進行中的任務。 |
| DescribeDBInstancesForClone | 獲取克隆數據庫實例 | 調用DescribeDBInstancesForClone查看實例列表。 |
| DescribeDBInstancesByPerformance | 按性能獲取數據庫實例 | 調用DescribeDBInstancesByPerformance接口查詢實例性能。 |
| DescribeDBInstanceDetail | 獲取數據庫實例詳細信息 | 調用DescribeDBInstanceDetail接口查詢實例詳情。 |
| DescribeRdsResourceSettings | 獲取RDS資源設置 | 此API已廢棄，不再使用。 |
| DescribeDBInstancesAsCsv | 按CSV文件格式查詢實例列表 | 該接口用于查詢實例列表。 |
| DescribeDBInstancePromoteActivity | 查詢實例命中的促銷活動 | 該接口已下線，暫無法使用。 |
| DescribeBackupDatabase | 查詢備份集數據庫列表 | 查詢備份集下的數據庫列表，已下線。 |
| CopyDatabase | 復制數據庫 | 復制數據庫SQL Server 2008 R2版，已下線。 |