ApsaraDB for MySQL提供以下相關API介面。

執行個體管理

API 描述
DestroyDBInstance 該介面用於銷毀RDS執行個體,已下線。
ModifyDBInstanceDelayReplicationTime 該介面用於修改唯讀執行個體延遲時間,已下線。
CreateDBInstance 調用CreateDBInstance介面建立一個RDS執行個體。
DeleteDBInstance 調用DeleteDBInstance介面釋放RDS執行個體。
RestartDBInstance 調用RestartDBInstance介面重啟RDS執行個體。
RenewInstance 調用RenewInstance介面對RDS執行個體進行手動續約。
DescribeDBInstanceAttribute 調用DescribeDBInstanceAttribute介面查看RDS執行個體的詳細資料。
DescribeDBInstances 調用DescribeDBInstances介面查看RDS執行個體列表或被RAM授權的執行個體列表。
ModifyDBInstanceSpec 調用ModifyDBInstanceSpec介面變更RDS執行個體(包括常規執行個體和唯讀執行個體,不包括災備執行個體和臨時執行個體)的規格或儲存空間。
DescribeRegions 調用DescribeRegions介面查詢當前可選的RDS地區和可用性區域資訊。
DescribeDBInstanceHAConfig 調用DescribeDBInstanceHAConfig介面查詢RDS執行個體高可用模式和資料複製方式。
MigrateToOtherZone 調用MigrateToOtherZone介面將RDS執行個體遷移至其他可用性區域。
PurgeDBInstanceLog 調用PurgeDBInstanceLog介面清理或收縮RDS執行個體日誌。
UpgradeDBInstanceEngineVersion 調用UpgradeDBInstanceEngineVersion介面升級執行個體資料庫版本。
ModifyDBInstanceDescription 調用ModifyDBInstanceDescription介面修改RDS執行個體的描述。
ModifyDBInstanceMaintainTime 調用ModifyDBInstanceMaintainTime介面修改RDS執行個體可維護時間段。
ModifyDBInstanceHAConfig 調用ModifyDBInstanceHAConfig介面修改執行個體的高可用模式和資料複製方式。
SwitchDBInstanceHA 調用SwitchDBInstanceHA介面切換RDS執行個體的主備執行個體。
CreateReadOnlyDBInstance 調用CreateReadOnlyDBInstance介面為某個執行個體建立一個唯讀執行個體。
ModifyDBInstanceAutoUpgradeMinorVersion 調用ModifyDBInstanceAutoUpgradeMinorVersion介面修改RDS執行個體升級小版本的方式。
ModifyHASwitchConfig 調用ModifyHASwitchConfig介面開啟或關閉RDS執行個體的主備切換功能。
DescribeHASwitchConfig 調用DescribeHASwitchConfig介面查看RDS執行個體主備自動切換設定。
DescribeAvailableResource 調用DescribeAvailableResource介面查詢某地區可售賣資源資訊。

歷史事件

API 描述
DescribeEvents 調用DescribeEvents介面查詢RDS事件記錄列表。
DescribeActionEventPolicy 調用DescribeActionEventPolicy介面查看RDS歷史事件功能開啟情況。
ModifyActionEventPolicy 調用ModifyActionEventPolicy介面開啟或關閉RDS歷史事件功能。

CloudDBA資料庫效能最佳化

API 描述
CreateDiagnosticReport 調用CreateDiagnosticReport介面建立診斷報告。
DescribeDiagnosticReportList 調用DescribeDiagnosticReportList介面擷取診斷報告列表。

資料庫管理

API 描述
ModifyCollationTimeZone 調用ModifyCollationTimeZone介面修改系統庫的字元集定序和時區,已下線。
CreateDatabase 調用CreateDatabase介面在某個執行個體下建立資料庫。
DeleteDatabase 調用DeleteDatabase介面刪除執行個體下的某個資料庫。
DescribeDatabases 調用DescribeDatabases介面查看執行個體下的資料庫資訊。
ModifyDBDescription 調用ModifyDBDescription介面修改資料庫備忘。
CopyDatabase 調用CopyDatabase介面複製資料庫SQL Server 2008 R2版,已下線。
CopyDatabaseBetweenInstances 調用CopyDatabaseBetweenInstances介面在執行個體間複製資料庫。
DescribeCollationTimeZones 調用DescribeCollationTimeZones介面查看支援的字元集定序和時區。

資料庫代理

API 描述
ModifyDBInstanceConnectionMode 調用ModifyDBInstanceConnectionMode介面開啟或關閉資料庫代理,已下線。
ModifyDBInstanceProxyConfiguration 調用ModifyDBInstanceProxyConfiguration介面設定資料庫代理,已下線。
DescribeDBInstanceProxyConfiguration 調用DescribeDBInstanceProxyConfiguration介面查看資料庫代理設定,已下線。
AllocateReadWriteSplittingConnection 調用AllocateReadWriteSplittingConnection介面申請讀寫分離地址。
CalculateDBInstanceWeight 調用CalculateDBInstanceWeight介面查詢系統權重分配值。
ModifyReadWriteSplittingConnection 調用ModifyReadWriteSplittingConnection介面修改讀寫分離鏈路的延遲閾值和各個執行個體的讀權重。
ReleaseReadWriteSplittingConnection 調用ReleaseReadWriteSplittingConnection介面釋放讀寫分離地址。

帳號管理

API 描述
CreateAccount 調用CreateAccount介面建立管理資料庫的帳號。
DeleteAccount 調用DeleteAccount介面刪除資料庫帳號。
DescribeAccounts 調用DescribeAccounts介面查看執行個體的帳號資訊。
GrantAccountPrivilege 調用GrantAccountPrivilege介面授權帳號訪問資料庫。
RevokeAccountPrivilege 調用RevokeAccountPrivilege介面撤銷帳號對資料庫的存取權限。
ModifyAccountDescription 調用ModifyAccountDescription介面修改資料庫帳號的描述。
ResetAccountPassword 調用ResetAccountPassword介面重設帳號密碼。
ResetAccount 調用ResetAccount介面重設高許可權帳號的許可權。

安全管理

API 描述
DescribeDBInstanceIPArrayList 調用DescribeDBInstanceIPArrayList介面查看RDS執行個體IP白名單。
DescribeDBInstanceSSL 調用DescribeDBInstanceSSL介面查詢執行個體SSL設定。
DescribeDBInstanceTDE 調用DescribeDBInstanceTDE介面查詢執行個體資料加密狀態。
ModifyDBInstanceSSL 調用ModifyDBInstanceSSL介面修改執行個體SSL鏈路。
ModifyDBInstanceTDE 調用ModifyDBInstanceTDE介面開啟RDS執行個體透明資料加密功能。
ModifySecurityIps 調用ModifySecurityIps介面修改白名單。
MigrateSecurityIPMode 調用MigrateSecurityIPMode介面把白名單從通用模式切換為高安全模式。
DescribeDBInstanceIpHostname 調用DescribeDBInstanceIpHostname介面查詢RDS執行個體的底層ECS執行個體的hostname。
DescribeDTCSecurityIpHostsForSQLServer 調用DescribeDTCSecurityIpHostsForSQLServer介面查詢RDS執行個體的分散式交易白名單資訊。
ModifyDTCSecurityIpHostsForSQLServer 調用ModifyDTCSecurityIpHostsForSQLServer介面設定分散式交易白名單。

網路管理

API 描述
AllocateInstancePublicConnection 調用AllocateInstancePublicConnection介面申請執行個體的外網地址。
DescribeDBInstanceNetInfo 調用DescribeDBInstanceNetInfo介面查看執行個體的所有串連地址資訊。
ModifyDBInstanceNetworkExpireTime 調用ModifyDBInstanceNetworkExpireTime介面修改串連地址到期時間。
ModifyDBInstanceConnectionString 調用ModifyDBInstanceConnectionString介面修改執行個體的串連地址和連接埠。
ModifyDBInstanceNetworkType 調用ModifyDBInstanceNetworkType介面切換RDS執行個體網路類型。
ReleaseInstancePublicConnection 調用ReleaseInstancePublicConnection介面釋放執行個體的外網串連地址。
SwitchDBInstanceNetType 調用SwitchDBInstanceNetType介面切換內外網地址。

日誌管理

API 描述
DescribeSlowLogs 調用DescribeSlowLogs查看慢日誌統計情況。
DescribeSlowLogRecords 調用DescribeSlowLogRecords介面查看執行個體的慢日誌明細。
DescribeErrorLogs 調用DescribeErrorLogs介面查看執行個體某段時間內的錯誤記錄檔。
DescribeBinlogFiles 調用DescribeBinlogFiles介面查看Binlog日誌。
ModifySQLCollectorPolicy 調用ModifySQLCollectorPolicy介面開啟或關閉執行個體的SQL審計功能。
DescribeSQLLogRecords 調用DescribeSQLLogRecords介面查詢執行個體的SQL審計日誌。
DescribeSQLLogFiles 調用DescribeSQLLogFiles介面查詢SQL審計檔案清單。

備份恢複

API 描述
CreateBackup 調用CreateBackup介面為執行個體建立一個備份組。
CloneDBInstance 調用CloneDBInstance介面將歷史資料恢複至一個新執行個體(稱為複製執行個體)。
DescribeBackups 調用DescribeBackups介面查看備份組列表。
CreateTempDBInstance 調用CreateTempDBInstance介面建立臨時執行個體。
DescribeBackupPolicy 調用DescribeBackupPolicy介面查看執行個體備份設定。
ModifyBackupPolicy 調用ModifyBackupPolicy介面修改備份設定。
RestoreDBInstance 調用RestoreDBInstance介面恢複備份組到原執行個體(覆蓋性恢複),已下線。
DeleteBackup 調用DeleteBackup介面刪除資料備份檔案。
RecoveryDBInstance 調用RecoveryDBInstance介面恢複資料庫。
DescribeBackupTasks 調用DescribeBackupTasks介面查詢執行個體的備份工作清單。
DescribeLogBackupFiles 調用DescribeLogBackupFiles介面查詢執行個體的記錄備份檔案。
DescribeBackupDatabase 調用DescribeBackupDatabase介面查詢備份組下的資料庫列表,已下線。
RestoreTable 調用RestoreTable介面恢複RDS執行個體的某個資料庫或表到原執行個體上。

跨地區備份恢複

API 描述
CheckCreateDdrDBInstance 調用CheckCreateDdrDBInstance介面預檢查某RDS執行個體是否可以用跨地區備份組進行跨地區恢複。
CreateDdrInstance 調用CreateDdrInstance介面跨地區恢複資料到新執行個體。
ModifyInstanceCrossBackupPolicy 調用ModifyInstanceCrossBackupPolicy介面修改RDS跨地區備份設定。
DescribeInstanceCrossBackupPolicy 調用DescribeInstanceCrossBackupPolicy介面查詢跨地區備份設定。
DescribeCrossRegionBackups 調用DescribeCrossRegionBackups介面查看某RDS執行個體跨地區資料備份檔案清單。
DescribeCrossRegionLogBackupFiles 調用DescribeCrossRegionLogBackupFiles介面查看跨地區記錄備份檔案清單。
DescribeAvailableCrossRegion 調用DescribeAvailableCrossRegion介面查詢所選地區當前可以進行跨地區備份的目的地區。
DescribeAvailableRecoveryTime 調用DescribeAvailableRecoveryTime介面查詢某跨地區備份檔案可恢複哪個時間段的資料。
DescribeCrossRegionBackupDBInstance 調用DescribeCrossRegionBackupDBInstance介面查詢所選地區的哪些執行個體開啟了跨地區備份,以及這些執行個體的跨地區備份設定。

SQL Server備份檔案上雲

API 描述
CreateMigrateTask 調用CreateMigrateTask介面將OSS上的備份檔案還原到RDS執行個體,實現資料上雲。
DescribeMigrateTasks 調用DescribeMigrateTasks介面查詢備份資料上雲工作清單。
DescribeOssDownloads 調用DescribeOssDownloads介面查看備份資料上雲任務的檔案詳情。
CreateOnlineDatabaseTask 在備份資料上雲時調用CreateOnlineDatabaseTask介面開啟資料庫。

監控管理

API 描述
DescribeResourceUsage 調用DescribeResourceUsage介面查看執行個體的空間利用資訊。
DescribeDBInstancePerformance 調用DescribeDBInstancePerformance介面查看執行個體效能資料。
DescribeDBInstanceMonitor 調用DescribeDBInstanceMonitor介面查詢監控頻率。
ModifyDBInstanceMonitor 調用ModifyDBInstanceMonitor修改監控頻率。

參數管理

API 描述
DescribeParameterTemplates 調用DescribeParameterTemplates介面查看資料庫參數模板。
DescribeParameters 調用DescribeParameters介面查詢執行個體當前的參數配置。
ModifyParameter 調用ModifyParameter介面修改執行個體參數。

資料移轉

API 描述
ImportDatabaseBetweenInstances 調用ImportDatabaseBetweenInstances介面從其它RDS執行個體遷入資料。
CancelImport 調用CancelImport介面用於取消RDS執行個體遷移任務。

標籤管理

API 描述
AddTagsToResource 調用AddTagsToResource介面為執行個體綁定標籤。
DescribeTags 調用DescribeTags介面查詢RDS執行個體的標籤。
RemoveTagsFromResource 調用RemoveTagsFromResource介面解除綁定標籤。