全部產品
Search
文件中心

ApsaraDB RDS:API 概覽

更新時間:Oct 28, 2026

API標準及多語言預置SDK

本產品(Rds/2014-08-15)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。

在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。

費用

API

標題

API概述

TransformDBInstancePayType 變更 RDS 執行個體的計費方式 該介面用於變更 RDS 執行個體的計費方式。
ModifyDBInstancePayType 按量計費執行個體轉包年包月。 將按量計費的資料庫執行個體變更為包年包月計費模式。
ModifyInstanceAutoRenewalAttribute 修改RDS執行個體的自動續費設定 修改雲端資料庫RDS執行個體的自動續費配置。
DescribePrice 查詢執行個體的價格 該介面用於查詢 RDS 執行個體的價格資訊。
DescribeRenewalPrice 查詢RDS執行個體續費的費用 該介面用於查詢包年包月RDS執行個體續費的費用。
DescribeInstanceAutoRenewalAttribute 查詢 RDS 執行個體自動續費情況。 該介面用於查詢 RDS 執行個體自動續費情況。
RenewInstance 手動續費 RDS 執行個體。 為包年包月 RDS 執行個體手動續費。
DescribeDBInstancePromoteActivity 查詢執行個體命中的促銷活動(停止維護) 該介面已停止維護:可以正常呼叫,但不再維護。

執行個體

API

標題

API概述

CreateDBInstance 建立RDS執行個體 該介面用於建立RDS執行個體。
CreateDBInstanceForRebuild 資源回收筒重建執行個體 該介面用於重建已進入資源回收筒的執行個體。
DeleteDBInstance 釋放RDS執行個體。 該介面用於釋放RDS執行個體。
RestartDBInstance 重啟RDS執行個體。 該介面用於手動重啟RDS執行個體。
StopDBInstance 暫停RDS執行個體。 該介面用於暫停RDS執行個體。
StartDBInstance 啟動RDS執行個體 該介面用於啟動暫停的RDS執行個體。
ModifyDBInstanceSpec 變更RDS執行個體 該介面用於變更RDS執行個體的規格和儲存空間等。
DestroyDBInstance 銷毀執行個體。 該介面用於銷毀回收站中的 RDS 執行個體。
ModifyDasInstanceConfig 設定儲存空間自動擴容 該介面用於設定RDS執行個體的儲存空間自動擴容功能。
MigrateToOtherZone 遷移RDS執行個體可用區 該介面用於遷移RDS執行個體的可用區。
ModifyDBInstanceDescription 修改執行個體名稱。 該介面用於修改RDS執行個體的名稱。
ModifyDBInstanceMaintainTime 修改執行個體可維護時間段。 該介面用於修改 RDS 執行個體的可維護時間段。
ModifyResourceGroup 修改執行個體資源群組。 該介面用於將 RDS 執行個體移動到指定資源群組。
ModifyHADiagnoseConfig 修改執行個體可用性檢測方式 該介面用於修改 RDS 執行個體的可用性檢測方式。
ModifyAccountSecurityPolicy 設定 SQL Server 帳號密碼策略 該介面用於修改 RDS SQL Server 執行個體的帳號密碼策略。
DescribeSupportOnlineResizeDisk 查詢執行個體是否支援線上擴充磁碟 該介面用於查詢 RDS SQL Server 執行個體是否支援線上擴充磁碟。
DescribeAvailableZones 查詢可用區資源 該介面用於查詢RDS的可用區資源。
DescribeAvailableClasses 查詢執行個體可變更規格 該介面用於查詢RDS執行個體的可變更規格及儲存空間等資訊。
DescribeDBInstanceAttribute 查詢執行個體詳情。 該介面用於查詢RDS執行個體的詳細資訊。
GetDBInstanceTopology 查詢執行個體拓撲資訊 該介面用於查看RDS執行個體的拓撲結構。
DescribeDBInstances 查詢執行個體列表 該介面用於查詢RDS的執行個體列表。
ListClasses 查詢規格資訊 該介面用於查詢RDS執行個體所有規格的詳情。
DescribeDBInstancesByExpireTime 按過期時間獲取資料庫執行個體 該介面用於透過包年包月執行個體的剩餘可用時間查詢 RDS 執行個體資訊。
DescribeRegions 查看可選的地域和可用區 該介面用於查詢所有RDS地域和可用區詳情(包含已裁撤地域,請謹慎使用)。
CheckInstanceExist 查詢執行個體是否存在。 該介面用於查詢目標 RDS 執行個體是否存在。
DescribeHADiagnoseConfig 查詢執行個體可用性檢測方式 該介面用於查詢RDS執行個體的可用性檢測方式。
CheckCloudResourceAuthorized 查詢 RDS 執行個體的授權狀態 該介面用於查詢 RDS 執行個體的權限狀態。
ReleaseInstanceConnection 釋放執行個體外網連線位址。 該介面用於釋放RDS執行個體的外網連線位址。
DescribeDBInstanceDetail 取得 RDS SQL Server 執行個體詳細資訊 該介面用於查詢 RDS SQL Server 執行個體詳情。
DescribeDBInstancesByPerformance 按效能取得資料庫執行個體 該介面用於按效能查詢資料庫執行個體。
DescribeDBInstancesForClone 查看複製資料庫執行個體(停止維護) 該介面用于查看複製資料庫執行個體。已停止維護:可以正常呼叫,但不再維護。
DescribeDBInstancesAsCsv 按CSV檔案格式查詢執行個體清單(停止維護) 該介面用於查詢執行個體清單。 已停止維護:可以正常呼叫,但不再維護。

升級版本

API

標題

API概述

ModifyDBInstanceAutoUpgradeMinorVersion 修改RDS升級核心小版本的方式 該介面用於修改RDS MySQL、PostgreSQL和SQL Server執行個體升級小版本的方式。
DescribeUpgradeMajorVersionPrecheckTask 查詢RDS大版本升級檢查報告 該介面用於查詢RDS MySQL及RDS PostgreSQL大版本升級前檢查的檢查報告。
DescribeUpgradeMajorVersionTasks 查詢 RDS PostgreSQL 執行個體大版本升級任務。 該介面用於查詢 RDS PostgreSQL 執行個體大版本升級的歷史任務。
UpgradeDBInstanceEngineVersion 升級RDS MySQL資料庫大版本。 該介面用於升級RDS MySQL的資料庫大版本。
UpgradeDBInstanceKernelVersion 升級RDS執行個體核心小版本 該介面用於升級RDS執行個體的核心小版本。
UpgradeDBInstanceMajorVersionPrecheck RDS大版本升級前檢查。 該介面用於執行RDS MySQL及RDS PostgreSQL大版本升級前檢查。
UpgradeDBInstanceMajorVersion 升級 RDS PostgreSQL 資料庫大版本。 該介面用於發起 RDS PostgreSQL 執行個體大版本升級任務。

網路與連線位址

API

標題

API概述

AllocateInstancePublicConnection 申請外部網路連線地址。 該介面用於為 RDS 執行個體申請外網連線地址。
ReleaseInstancePublicConnection 釋放執行個體的外網連線地址。 該介面用於釋放執行個體的外網連線地址。
ModifyDBInstanceConnectionString 管理執行個體的連線位址和連接埠。 該介面用於管理執行個體的連線位址和連接埠。
ModifyDBInstanceNetworkExpireTime 修改混訪模式下傳統網路位址過期時間。 該介面用於修改混訪模式下傳統網路位址的過期時間。
SwitchDBInstanceNetType 切換經典網路內外網位址。 該介面用於切換經典網路執行個體的內外網位址。
ModifyDBInstanceNetworkType 經典網路切換為VPC網路 該介面用於將經典網路的RDS執行個體切換為VPC網路。
SwitchDBInstanceVpc 切換RDS執行個體的VPC和交換器 該介面用於切換RDS執行個體的專有網路VPC和交換器。
ModifyDBInstanceConfig 修改 RDS 執行個體的設定項目。 該介面用於修改 RDS 執行個體的設定項目。
DescribeDBInstanceNetInfo 查詢執行個體的所有連線位址資訊 該介面用於查詢RDS執行個體的所有連線位址資訊。
DescribeVSwitches 查詢虛擬交換器列表。 該介面用於查詢專有網路VPC下虛擬交換器的詳細資訊。

主備高可用性與資料複製方式

API

標題

API概述

ModifyDBInstanceHAConfig 修改執行個體的高可用模式和資料複製方式。 該介面用於修改 RDS 執行個體的高可用模式和資料複製方式。
ModifyHASwitchConfig 開啟或關閉RDS執行個體的主備自動切換功能。 該介面用於開啟或關閉RDS執行個體的主備自動切換功能。
DescribeDBInstanceHAConfig 查詢RDS執行個體高可用模式和資料複製方式 該介面用於查詢RDS執行個體的高可用模式和資料複製方式。
DescribeHASwitchConfig 查詢RDS執行個體主備自動切換設定。 該介面用於查詢RDS執行個體主備自動切換的設定。
SwitchDBInstanceHA RDS執行個體主備切換。 該介面用於RDS執行個體的手動主備切換。

歷史事件

API

標題

API概述

ModifyActionEventPolicy 開啟或關閉歷史事件。 該介面用於開啟或關閉RDS的歷史事件功能。
DescribeEvents 查詢歷史事件 該介面用於查詢RDS歷史事件記錄列表。
DescribeActionEventPolicy 查詢RDS歷史事件功能是否開啟。 該介面用於查詢RDS的歷史事件功能是否開啟。

通知

API

標題

API概述

QueryNotify 查詢通知 該介面用於查詢RDS的通知。
ConfirmNotify 確認通知 該介面用於確認主帳號下RDS控制台的輪播訊息。
DescribeRdsResourceSettings 取得 RDS 資源設定(停止維護) 該介面用於取得執行個體資源的通知設定資訊,已停止維護:可以正常呼叫,但不再維護。

帳號

API

標題

API概述

CreateAccount 建立資料庫帳號。 該介面用於建立資料庫帳號。
DeleteAccount 刪除資料庫帳號。 該介面用於刪除資料庫帳號。
ModifyAccountCheckPolicy 修改SQL Server帳號密碼策略 該介面用於修改RDS SQL Server資料庫的帳號密碼策略。
ModifyAccountDescription 修改資料庫帳號的備註資訊。 該介面用於修改資料庫帳號的描述資訊。
DescribeAccounts 查詢資料庫帳號資訊。 該介面用於查詢RDS執行個體的帳號資訊。
DescribeInstanceKeywords 取得執行個體的保留關鍵字資訊。 該介面用於查詢RDS執行個體的保留關鍵字,即建立資料庫或帳號時禁用的關鍵字。
ResetAccountPassword 重設資料庫帳號的密碼。 該介面用於重設資料庫帳號的密碼。
LockAccount 鎖定RDS PostgreSQL資料庫帳號。 該介面用於鎖定RDS PostgreSQL執行個體的資料庫帳號。
UnlockAccount 解鎖 RDS PostgreSQL 資料庫帳號。 該介面用於解鎖 RDS PostgreSQL 執行個體的資料庫帳號。
GrantAccountPrivilege 授權帳號存取資料庫。 該介面用於授予指定資料庫帳號對單個或多個資料庫的存取權限。
GrantOperatorPermission 授權服務帳號 該介面用於授權服務帳號。
RevokeOperatorPermission 撤銷服務帳號權限。 該介面用於撤銷阿里雲服務帳號對RDS執行個體的存取權限。
RevokeAccountPrivilege 撤銷帳號對資料庫的存取權限。 此介面用於撤銷帳號對資料庫的存取權限。
ResetAccount 重置高權限帳號權限。 該介面用於重置高權限帳號的權限。
CheckAccountNameAvailable 檢查帳號名稱是否可用。 該介面用於檢查目標需要建立的帳號名稱是否可用。

資料庫

API

標題

API概述

CreateDatabase 建立資料庫 該介面用於在RDS執行個體下建立資料庫。
DeleteDatabase 刪除資料庫。 該介面用於刪除RDS執行個體中指定資料庫。
CopyDatabase 複製資料庫。 複製資料庫SQL Server 2008 R2版。
ModifyDBDescription 修改資料庫備註說明 該介面用於修改資料庫的備註。
ModifyDatabaseConfig 修改資料庫屬性 該介面用於修改 RDS SQL Server 資料庫屬性。
ModifyCollationTimeZone 修改系統字元集排序規則和時區。 修改RDS SQL Server系統字元集排序規則和時區。
DescribeDatabases 查看執行個體下的資料庫資訊 該介面用於查詢RDS執行個體下的資料庫資訊。
DescribeCollationTimeZones 查詢 RDS SQL Server 支援的字元集排序規則和時區。 該介面用於查詢 RDS SQL Server 支援的字元集排序規則和時區。
DescribeCharacterSetName 查看資料庫支援的字元集列表。 該介面用於查詢RDS執行個體支援的字元集。
CopyDatabaseBetweenInstances RDS SQL Server 執行個體間複製資料庫 該介面用於在 RDS SQL Server 執行個體間複製資料庫。
CheckDBNameAvailable 檢查資料庫名稱是否可用。 該介面用於檢查資料庫名稱是否重複或不符合命名規範。

唯讀執行個體

API

標題

API概述

CreateReadOnlyDBInstance 建立唯讀執行個體。 該介面用於為RDS執行個體建立一個唯讀執行個體。
ModifyReadonlyInstanceDelayReplicationTime 修改 RDS MySQL 唯讀執行個體的延遲複製時間。 該介面用於修改 RDS MySQL 唯讀執行個體的延遲複製時間。
DescribeReadDBInstanceDelay 查詢 RDS 唯讀執行個體的延遲資訊。 該介面用於查詢 RDS 唯讀執行個體的延遲資訊。
PrecheckDuckDBDependency 檢查建立 DuckDB 分析執行個體前提條件 該介面用於檢查 RDS PostgreSQL 主執行個體是否滿足建立 DuckDB 分析執行個體的前提條件。對於不滿足的條件將傳回失敗原因,並提供解決方案或建議的目標值。

RDS 叢集系列執行個體

API

標題

API概述

CreateDBNodes 建立節點 該介面用於為RDS叢集系列執行個體新增節點。
CreateDBInstanceEndpoint 建立執行個體的Endpoint 該介面用於為RDS叢集系列執行個體建立Endpoint。
CreateDBInstanceEndpointAddress 建立Endpoint外網連線地址 該介面用於為RDS叢集系列執行個體建立Endpoint的外網連線地址。
DeleteDBNodes 刪除節點 該介面用於為RDS叢集系列執行個體刪除節點。
DeleteDBInstanceEndpoint 刪除執行個體的 Endpoint 該介面用於刪除 RDS 叢集系列執行個體的 Endpoint。
DeleteDBInstanceEndpointAddress 釋放 Endpoint 外網連線地址 該介面用於釋放 RDS 叢集系列執行個體的 Endpoint 的外網連線地址。
ModifyDBInstanceEndpoint 修改執行個體的 Endpoint 權重資訊 該介面用於修改 RDS 叢集系列執行個體的 Endpoint 權重資訊。
ModifyDBInstanceEndpointAddress 修改執行個體的 Endpoint 連線位址資訊 該介面用於修改 RDS 叢集系列執行個體的 Endpoint 連線位址資訊。
DescribeDBInstanceEndpoints 查詢執行個體Endpoint資訊 該介面用於查詢RDS叢集系列執行個體的Endpoint資訊。

資料庫代理

API

標題

API概述

CreateDBProxyEndpointAddress 新增資料庫代理的連線位址 該介面用於新增 RDS 執行個體資料庫代理的連線位址。
DeleteDBProxyEndpointAddress 刪除資料庫代理連線位址 該介面用於刪除 RDS 執行個體資料庫代理的連線位址。
ModifyDBProxy 開通或修改資料庫代理執行個體功能 該介面用於開啟或者修改RDS執行個體的資料庫代理執行個體功能。
UpgradeDBProxyInstanceKernelVersion 升級資料庫代理核心小版本 該介面用於升級資料庫代理的核心小版本。
ModifyDBProxyInstance 變更資料庫代理執行個體配置 該介面用於變更RDS資料庫代理執行個體相關配置。
ModifyDBProxyEndpoint 設定資料庫代理連線地址存取策略 該介面用於設定RDS執行個體資料庫代理連線地址的存取策略。
ModifyDBProxyEndpointAddress 修改資料庫代理的連線位址 該介面用於修改RDS執行個體資料庫代理的連線位址。
ModifyDbProxyInstanceSsl 設定資料庫代理連線位址 SSL 加密 該介面用於設定 RDS MySQL 資料庫代理連線位址的 SSL 加密。
DescribeDBProxy 查詢資料庫代理詳情 該介面用於查詢 RDS 執行個體的資料庫代理設定詳情。
DescribeDBProxyEndpoint 查詢資料庫代理的連線地址資訊 該介面用於查詢 RDS 執行個體資料庫代理的連線地址資訊。
DescribeDBProxyPerformance 查詢資料庫代理的效能資料 該介面用於查詢RDS執行個體資料庫代理的效能資料。
GetDbProxyInstanceSsl 查詢資料庫代理連線位址 SSL 加密資訊 該介面用於查詢 RDS MySQL 資料庫代理連線位址 SSL 加密資訊。

資料庫共用代理(下線中)

API

標題

API概述

ModifyReadWriteSplittingConnection 修改讀寫分離鏈路的延遲閾值和各個執行個體的讀權重 該介面用於修改讀寫分離鏈路的延遲閾值和各個執行個體的讀權重。
DescribeDBInstanceProxyConfiguration 查看資料庫代理設定。 該介面用於查看 RDS MySQL 資料庫代理設定。
AllocateReadWriteSplittingConnection 申請唯讀位址。 該介面用於申請唯讀位址。
ReleaseReadWriteSplittingConnection 釋放讀寫分離位址 該介面用於釋放讀寫分離位址。
CalculateDBInstanceWeight 查詢系統權重分配值 該介面用於查詢系統權重分配值。

安全加密

API

標題

API概述

AttachWhitelistTemplateToInstance 關聯白名單範本到執行個體 該介面用於將白名單範本關聯到執行個體。
CreateServiceLinkedRole 建立服務關聯角色(SLR) 該介面用於建立服務關聯角色(SLR)。
DetachWhitelistTemplateToInstance 取消關聯白名單範本與執行個體 該介面用於取消關聯的白名單範本與執行個體。
ModifyWhitelistTemplate 編輯白名單範本資訊 該介面用於編輯白名單範本,包括建立、修改、刪除白名單範本的操作。
DescribeSecurityGroupConfiguration 查詢RDS執行個體和ECS安全性群組關聯資訊。 該介面用於查詢指定RDS執行個體和ECS安全性群組的關聯資訊。
ModifySecurityGroupConfiguration 修改RDS執行個體和ECS安全性群組關聯資訊。 該介面用於修改指定RDS執行個體和ECS安全性群組的關聯資訊。
CreateDBInstanceSecurityGroupRule 新增安全性群組規則 該介面用於為 RDS SQL Server 執行個體新增安全性群組規則。
DescribeDBInstanceSecurityGroupRule 查看安全性群組規則 該介面用於查詢RDS SQL Server執行個體的安全性群組規則。
ModifyDBInstanceSecurityGroupRule 修改安全性群組規則 該介面用於修改RDS SQL Server執行個體的安全性群組規則。
DeleteDBInstanceSecurityGroupRule 刪除安全性群組規則。 該介面用於刪除 RDS SQL Server 執行個體已設定的安全性群組規則。
ModifySecurityIps 修改RDS執行個體IP白名單 修改指定RDS執行個體的IP白名單配置,支援覆蓋、追加、刪除三種修改模式。
ModifyDBInstanceSSL 修改RDS執行個體的SSL配置 該介面用於修改RDS執行個體的SSL鏈路配置。
ModifyDBInstanceTDE 修改RDS執行個體透明資料加密TDE狀態 該介面用於開啟RDS執行個體的透明資料加密TDE功能,並支援修改加密狀態。
ModifyDTCSecurityIpHostsForSQLServer 設定分散式交易白名單。 該介面用於為 RDS SQL Server 執行個體設定分散式交易白名單。
ModifyDBInstanceDeletionProtection 開啟或關閉執行個體釋放保護 該介面用於開啟或關閉RDS執行個體的釋放保護功能。
DescribeWhitelistTemplateLinkedInstance 查詢白名單範本關聯執行個體 該介面用於根據白名單範本查詢關聯的執行個體。
DescribeInstanceLinkedWhitelistTemplate 查詢執行個體關聯的白名單範本 該介面用於根據執行個體的名稱查詢關聯的白名單範本。
DescribeWhitelistTemplate 查詢白名單範本資訊 該介面用於取得指定的白名單範本資訊。
DescribeAllWhitelistTemplate 批次查詢白名單範本資訊 該介面用於批次獲取白名單範本,支援模糊查詢。
DescribeDBInstanceIPArrayList 查看RDS執行個體IP白名單 該介面用於查詢RDS執行個體的IP白名單。
DescribeDBInstanceSSL 查詢RDS執行個體的SSL配置。 該介面用於查詢RDS執行個體的SSL設定情況。
DescribeDBInstanceTDE 查詢RDS執行個體透明資料加密TDE狀態 該介面用於查詢RDS執行個體的透明資料加密TDE的加密狀態。
DescribeDBInstanceEncryptionKey 查詢雲端硬碟加密狀態及金鑰詳情 查詢RDS執行個體是否開啟了雲端硬碟加密,以及金鑰詳情。
DescribeDBInstanceIpHostname 查詢 RDS SQL Server 執行個體底層 ECS 執行個體的 IpHostnameInfos 資訊。 該介面用於查詢 RDS SQL Server 執行個體底層所在 ECS 執行個體的內部網路 IP 和 ECS 主機名稱。
DescribeDTCSecurityIpHostsForSQLServer 查詢 RDS 執行個體的分散式交易白名單資訊 該介面用於查詢 RDS SQL Server 執行個體的分散式交易白名單資訊。
MigrateSecurityIPMode 將白名單從通用模式切換為高安全模式。 該介面用於將 RDS 執行個體的白名單從通用模式切換為高安全模式。

日誌

API

標題

API概述

DescribeSQLLogReportList 取得SQL日誌報告清單。 該介面用於查看 SQL 日誌執行報告清單。
PurgeDBInstanceLog 清理或收縮 RDS 執行個體日誌。 該介面用於清理 RDS 執行個體的本機日誌。
DescribeSQLLogFiles 查詢 SQL 洞察(SQL 審計)匯出檔案清單 該介面用於查詢 SQL 洞察(SQL 稽核)匯出檔案清單。不支援查詢透過控制台手動匯出的 SQL 洞察日誌檔案,只支援查詢透過 DescribeSQLLogRecords 介面產生(請求參數 Form 取值為 File)的 SQL 洞察檔案清單。
DescribeSlowLogs 檢視慢日誌統計情況 該介面用於查詢慢日誌統計情況。
DescribeSlowLogRecords 查看慢日誌明細 該介面用於查看執行個體的慢日誌明細。
DescribeErrorLogs 查看錯誤日誌 該介面查詢執行個體某段時間內的錯誤日誌。
ModifySQLCollectorPolicy 開啟或關閉執行個體的SQL稽核功能(停止維護) 停止維護:可以正常呼叫,但不再維護。該介面用於開啟或關閉執行個體的SQL洞察(SQL稽核)功能。
ModifySQLCollectorRetention 修改RDS執行個體的SQL洞察日誌保存時長(停止維護) 停止維護:可以正常呼叫,但不再維護。該介面用於修改RDS執行個體的SQL洞察日誌保存時長。
DescribeSQLCollectorPolicy 查詢執行個體的SQL審計功能是否開啟(停止維護) 停止維護:可以正常呼叫,但不再維護。該介面用於查詢RDS執行個體的SQL洞察(SQL審計)功能是否開啟。
DescribeSQLLogRecords 查詢執行個體的 SQL 稽核日誌(停止維護) 停止維護:可以正常呼叫,但不再維護。該介面用於查詢 RDS 執行個體的 SQL 洞察(SQL 稽核)日誌。
DescribeSQLCollectorRetention 查詢RDS執行個體的SQL洞察日誌儲存時長(停止維護) 停止維護:可以正常呼叫,但不再維護。該介面用於查詢RDS執行個體的SQL洞察日誌儲存時長。

備份

API

標題

API概述

ModifyBackupSetExpireTime 修改備份集的到期時間 該介面用於延長手動備份產生的單一資料庫備份集(物理備份、完整備份、單一資料庫備份)的到期時間。
CreateBackup 為RDS執行個體建立備份集 該介面用於為RDS執行個體建立一個備份集。
DeleteBackup 刪除執行個體資料備份檔案。 該介面用於刪除RDS執行個體的資料備份檔案。
DeleteBackupFile 刪除 SQL Server 備份檔案。 該介面用於刪除 RDS SQL Server 的備份檔案。新使用者不支援使用該介面,此前已加入白名單的使用者仍可正常使用。
ModifyBackupPolicy 修改執行個體備份策略 此介面用於修改 RDS 執行個體的備份策略設定。
DescribeBackups 檢視RDS執行個體備份集列表 該介面用於檢視RDS執行個體的備份集列表。
DescribeDetachedBackups 查詢已被釋放的RDS MySQL執行個體中備份集列表 該介面用於查看已被釋放的RDS MySQL執行個體的備份集列表。
DescribeBackupPolicy 檢視執行個體備份設定 該介面用於查詢RDS執行個體的備份設定。
DescribeBackupTasks 查詢執行個體的備份任務列表 該介面用於查詢RDS執行個體的備份任務列表。
DescribeBinlogFiles 檢視RDS執行個體的日誌(Binglog/Wal)檔案。 該介面用於查詢 RDS MySQL/RDS MariaDB 執行個體的 Binlog 日誌或 RDS PostgreSQL 執行個體的 WAL 日誌。
DescribeLogBackupFiles 查詢執行個體的記錄檔備份檔案。 該介面用於查詢 RDS SQL Server 執行個體的記錄檔備份檔案。
DescribeBackupDatabase 查詢備份集資料庫列表。 查詢備份集下的資料庫列表。

還原

API

標題

API概述

CreateTempDBInstance 建立臨時執行個體。 該介面用於為 RDS SQL Server 2008 R2 高效能本地磁碟執行個體建立臨時執行個體。
DescribeLocalAvailableRecoveryTime 查詢RDS執行個體備份可恢復的時間範圍 該介面用於查詢RDS執行個體備份可恢復的時間範圍。
DescribeMetaList 查詢備份集的資料庫與資料表資訊 該介面用於查詢目標備份集中可復原的資料庫與資料表資訊。
RecoveryDBInstance 恢復SQL Server資料 該介面用於將RDS SQL Server備份資料恢復到已有執行個體或新執行個體上。
CloneDBInstance 恢復資料(複製執行個體) 該介面用於將歷史資料恢復至一個新執行個體(稱為複製執行個體)。
RestoreTable 還原RDS執行個體的某些資料庫或資料表到原執行個體。 該介面擁有恢復RDS執行個體的某些資料庫或資料表到原執行個體。

跨地域備份還原

API

標題

API概述

CreateDdrInstance 跨地域恢復資料到新執行個體 該介面用於跨地域恢復資料到新執行個體。
ModifyInstanceCrossBackupPolicy 修改RDS跨地域備份設定 該介面用於修改RDS跨地域備份設定。
DescribeInstanceCrossBackupPolicy 查詢跨地域備份設定。 該介面用於查詢跨地域備份設定。
DescribeCrossBackupMetaList 查詢執行個體跨地域備份的資料庫與資料表資訊 該介面用於查詢 RDS 執行個體跨地域備份的資料庫與資料表資訊。
DescribeCrossRegionBackups 查詢某RDS執行個體跨地域資料備份檔案列表 該介面用於查詢某RDS執行個體跨地域資料備份檔案列表。
DescribeCrossRegionLogBackupFiles 查詢跨區域日誌備份檔案清單。 該介面用於查詢跨地域日誌備份檔案清單。
DescribeAvailableCrossRegion 查詢可以進行跨地域備份的目的地域。 該介面用於查詢所選地域當前可以進行跨地域備份的目的地域。
DescribeAvailableRecoveryTime 查詢備份檔案可復原的時間段 該介面用於查詢某跨地域備份檔案可復原哪個時間段的資料。
DescribeCrossRegionBackupDBInstance 查詢開啟跨地域備份執行個體 該介面用於查詢所選地域的哪些執行個體開啟了跨地域備份,以及這些執行個體的跨地域備份設定。
CheckCreateDdrDBInstance 預檢查執行個體是否可以進行跨地域復原 該介面用於預檢查某RDS執行個體是否可以用跨地域備份集進行跨地域復原。
RestoreDdrTable 跨地域恢復資料到已有執行個體 該介面用於跨地域恢復資料到已有執行個體。

監控

API

標題

API概述

ModifyDBInstanceMonitor 設定執行個體的監控採集粒度 該介面用於修改監控頻率。
ModifyDBInstanceMetrics 修改 RDS PostgreSQL 展示的監控指標項目。 該介面用於變更 RDS PostgreSQL 執行個體展示的增強監控指標。
DescribeResourceUsage 查看執行個體的空間利用資訊 該介面用於查詢RDS執行個體的空間使用資訊。
DescribeDBInstancePerformance 查詢執行個體效能資料 該介面用於查詢執行個體效能資料。
DescribeDBInstanceMonitor 查詢監控頻率。 該介面用於查詢監控頻率。
DescribeAvailableMetrics 查詢RDS PostgreSQL的所有監控指標項目。 該介面用於取得RDS PostgreSQL執行個體支援的所有增強監控指標。
DescribeDBInstanceMetrics 查詢RDS PostgreSQL執行個體展示的監控指標項目。 該介面用於查詢RDS PostgreSQL執行個體已開啟展示的增強指標。

參數

API

標題

API概述

CreateParameterGroup 建立參數範本。 該介面用於建立 RDS 參數範本。
DeleteParameterGroup 刪除參數範本。 該介面用於刪除 RDS 參數範本。
ModifyParameter 修改執行個體參數。 該介面用於修改RDS執行個體的參數值。
ModifyParameterGroup 修改參數範本 該介面用於修改RDS參數範本。
DescribeParameters 查詢執行個體目前的參數配置 該介面用於查詢執行個體目前的參數配置。
DescribeModifyParameterLog 查詢RDS執行個體的參數修改日誌。 該介面用於查詢RDS執行個體的參數修改日誌。
DescribeParameterTemplates 查看參數範本詳情列表 該介面用於查詢資料庫參數範本。
DescribeParameterGroups 查詢目標地域的參數範本列表。 該介面用於查詢目標地域的參數範本列表。
DescribeParameterGroup 查詢指定的RDS參數範本資訊。 該介面用於查詢指定的RDS參數範本資訊。
CloneParameterGroup 複製參數範本。 該介面用於複製RDS參數範本到當前地域或其他地域內。

資料移轉

API

標題

API概述

DescibeImportsFromDatabase 檢視執行個體遷移狀態清單。 該介面用於查看執行個體遷移狀態列表。

維運任務管理

API

標題

API概述

ModifyActiveOperationTasks 修改多個主動維運任務切換時間。 該介面用於修改 RDS 執行個體計畫內維運任務的切換時間。
DescribeActiveOperationTasks 查詢多個主動維運任務資訊 該介面用於查看 RDS 執行個體的計畫內維運任務詳情。
CancelActiveOperationTasks 取消主動維運任務 該介面用於取消尚未開始的維運任務。

MySQL 備份檔案上雲端

API

標題

API概述

DeleteUserBackupFile 刪除使用者備份 該介面用於刪除RDS MySQL的目標使用者備份。
UpdateUserBackupFile 變更使用者備份資訊 該介面用於變更使用者備份的備註資訊和保留時長。
ListUserBackupFiles 查詢使用者備份資訊 該介面用於查詢所有已匯入至RDS的使用者備份的詳情。
ImportUserBackupFile 匯入使用者備份 該介面用於將自建資料庫 MySQL 5.7 的備份資料匯入至 RDS。

SQL Server 備份檔案上雲端

API

標題

API概述

CreateMigrateTask 建立上雲端遷移任務 該介面用於將OSS上的自建SQL Server備份檔案還原到RDS SQL Server執行個體,實現資料上雲端。
CreateOnlineDatabaseTask 打開備份資料上雲端任務的資料庫 該介面用於打開RDS SQL Server備份資料上雲端任務的資料庫。
DescribeMigrateTasks 查詢備份資料上雲端任務列表 該介面用於查詢 RDS SQL Server 執行個體備份資料上雲端任務列表。
DescribeOssDownloads 查看備份資料上雲端任務的檔案詳情 該介面用於查詢 RDS SQL Server 備份資料上雲端任務的檔案詳情。
DescribeMigrateTaskById 取得遷移任務 該介面用於查詢 SQL Server 的某個 OSS 備份上雲端任務的資訊。
TerminateMigrateTask 終止遷移任務 該介面用於終止進行中的 RDS SQL Server 的備份上雲端任務。

SQL Server AD 網域

API

標題

API概述

DeleteADSetting 刪除RDS SQL Server的AD網域關聯 該介面用於將當前RDS SQL Server執行個體退出所在網域。
ModifyADInfo 修改 RDS SQL Server 的 AD 網域設定 該介面用於修改 RDS SQL Server 執行個體的 AD 網域資訊。
DescribeADInfo 查詢 RDS SQL Server 的 AD 網域關聯資訊 該介面用於查詢目前執行個體網域相關資訊,包括是否已經加入網域、網域名稱、所使用帳號等。

PostgreSQL 一鍵上雲端

API

標題

API概述

CreateCloudMigrationPrecheckTask 建立 RDS PostgreSQL 一鍵上雲端前檢查任務。 該介面用於建立 RDS PostgreSQL 一鍵上雲端前檢查任務。
CreateCloudMigrationTask 建立RDS PostgreSQL遷移上雲端任務。 該介面用於建立RDS PostgreSQL遷移上雲端任務。
DescribeCloudMigrationPrecheckResult 查詢RDS PostgreSQL一鍵上雲端前檢查報告。 該介面用於查詢一鍵上雲前檢查報告詳細資訊。
DescribeCloudMigrationResult 查詢RDS PostgreSQL遷移上雲端任務詳情。 該介面用於查詢RDS PostgreSQL遷移上雲端任務詳情。
ActivateMigrationTargetInstance RDS PostgreSQL 上雲端切換。 該介面用於執行 RDS PostgreSQL 上雲端切換,將 RDS PostgreSQL 提升為主要資料庫,正式提供服務。

標籤

API

標題

API概述

TagResources 建立標籤 該介面用於為指定的 RDS 執行個體建立並綁定標籤。
AddTagsToResource 為執行個體綁定標籤 該介面用於為執行個體綁定標籤。
UntagResources 解綁標籤 該介面用於為指定的 RDS 執行個體解綁標籤。
RemoveTagsFromResource 為 RDS 執行個體解綁標籤。 該介面用於解綁標籤。
ListTagResources 查詢標籤和資源列表。 該介面用於查詢一個或多個RDS執行個體已經綁定的標籤列表。
DescribeTags 查詢標籤列表 該介面用於查詢 RDS 執行個體的標籤資訊。
DescribeDBInstanceByTags 查詢執行個體標籤資訊 該介面用於獲取執行個體綁定的標籤資訊。

管理 RDS PostgreSQL 外掛程式

API

標題

API概述

CreatePostgresExtensions 在目標資料庫下安裝指定外掛程式 該介面用於在目標資料庫下安裝指定外掛程式。
DeletePostgresExtensions 刪除執行個體目標資料庫下的指定外掛程式 該介面用於刪除執行個體目標資料庫下的指定外掛程式。
UpdatePostgresExtensions 升級目標資料庫下的指定外掛程式 該介面用於升級目標資料庫下的指定外掛程式。
DescribePostgresExtensions 獲取執行個體目標資料庫下所有外掛程式的資訊 該介面用於獲取執行個體目標資料庫下所有外掛程式的資訊。

PostgreSQL 執行個體 Replication Slot 管理

API

標題

API概述

DeleteSlot 刪除PostgreSQL執行個體Replication Slot。 該介面用於刪除執行個體的指定Replication Slot。
DescribeSlots 查詢 PostgreSQL 執行個體 Replication Slot。 該介面用於查詢執行個體的所有 Replication Slot。

災備執行個體

API

標題

API概述

CreateReplicationLink 建立災備執行個體的資料同步鏈路。 該介面用於建立RDS災備執行個體的資料同步鏈路。
DescribeReplicationLinkLogs 查詢 RDS 執行個體資料同步鏈路的操作日誌 該介面用於查詢指定 RDS 執行個體資料同步鏈路的操作日誌。
RebuildReplicationLink 為災備執行個體重建立資料同步鏈路 該介面用於為RDS災備執行個體重建立資料同步鏈路。
DeleteReplicationLink 刪除災備執行個體的資料同步鏈路並將其提升為主執行個體 該介面用於刪除 RDS 災備執行個體的資料同步鏈路,並將災備執行個體提升為主執行個體。

承諾型 Serverless

API

標題

API概述

ModifyComputeBurstConfig 修改或關閉承諾型 Serverless 功能。 呼叫該介面,修改或關閉承諾型 Serverless 功能。
DescribeComputeBurstConfig 查詢承諾型 Serverless 功能設定。 查詢承諾型 Serverless 功能的設定。

其他

API

標題

API概述

使用者憑證 使用者憑證
CreateSecret 建立使用者憑證 該介面用於建立 Data API 使用者憑證。
DeleteSecret 刪除使用者憑證。 呼叫 DeleteSecret 介面刪除 Data API 使用者憑證。
DescribeSecrets 查詢使用者憑證 該介面用於查詢Data API使用者憑證。
MigrateConnectionToOtherZone 遷移 RDS 執行個體至其他可用區 該介面用於遷移 RDS 執行個體的可用區。
ModifyDBInstanceDelayedReplicationTime 修改唯讀複製延遲閾值。 該介面用於設定 MySQL 唯讀執行個體的延遲時間。
CheckServiceLinkedRole 查詢是否已建立服務關聯角色(SLR) 該介面用於檢視是否已建立服務關聯角色(SLR)。
DescribeDBMiniEngineVersions 查詢可使用的核心版本清單 該介面用於查詢可用的 MySQL 或 PostgreSQL 小版本清單。
DescribeRegionInfos 查詢可見地域清單。 該介面用於取得地域清單。
DescribeDBInstanceNetInfoForChannel 查詢執行個體網路資訊。 該介面用於查詢RDS執行個體的所有連線位址資訊。
DescribeHostWebShell 查詢 RDS SQL Server 執行個體的主機 WebShell 登入資訊 該介面用於查詢 RDS SQL Server 執行個體的主機 WebShell 登入資訊。
DescribeClassDetails 查詢規格詳情 該介面用於透過規格代碼查詢規格詳情。
DescribeKmsAssociateResources 查詢KMS指定資源是否關聯RDS執行個體 該介面用於查詢KMS的指定資源是否關聯了RDS執行個體。
ModifyDBInstanceReplicationSwitch 修改執行個體原生複製開關狀態 呼叫ModifyDBInstanceReplicationSwitch介面開啟或關閉RDS原生複製模式。
DescribeDBInstanceReplication 查詢執行個體複製狀態 該介面用於查詢原生複製執行個體狀態與設定。
MigrateDBNodes 遷移RDS執行個體節點 該介面用於變更RDS MySQL叢集系列執行個體節點可用區。
SwitchOverMajorVersionUpgrade 大版本升級切換 用於RDS PostgreSQL的零停機大版本升級流量切換。
AuthorizeBackupEncryption 校驗備份加密 為使用者建立備份加密服務關聯角色 AliyunServiceRoleForRdsBackupEncryption。
CheckBackupEncryptionAuthorized 查詢備份加密校驗結果 檢查使用者帳號下是否已經建立備份加密服務關聯角色 AliyunServiceRoleForRdsBackupEncryption。
CheckRegionSupportBackupEncryption 檢查單元是否支援備份加密 檢查當前地域是否支援備份加密。
DescribeSQLServerUpgradeVersions 查詢 SQLServer 可升級版本 描述 SQLServer 執行個體或指定 SQLServer 版本允許升級到的版本。
DescribeVpcs 查詢專有網路VPC列表 用於查詢阿里雲帳戶下的專有網路(VPC)列表資訊。
EnableBackupEncryption 開啟備份加密 該介面用於開啟備份加密。
DescribeActiveOperationMaintainConf 查詢主動維運配置 獲取使用者的維運配置資訊,目前包括計畫內事件週期窗口資訊。
CreateMaskingRules 建立加密或脫敏規則 為指定執行個體建立新的加密或脫敏規則。
ModifyAccountMaskingPrivilege 修改帳戶脫敏權限 修改指定執行個體中帳號的加密或脫敏權限。
ModifyMaskingRules 修改加密或脫敏規則 用於修改指定執行個體的加密或脫敏規則。
DescribeMaskingRules 查詢加密或脫敏規則 查詢指定執行個體的加密或脫敏規則列表。
DeleteMaskingRules 刪除加密或脫敏規則 用於刪除指定執行個體的加密或脫敏規則。
DescribeAccountMaskingPrivilege 查詢帳號加密或脫敏權限 查詢指定執行個體中帳號的加密或脫敏權限配置。
DeleteParameterTimedScheduleTask 刪除參數修改排程任務 刪除執行個體參數修改的排程任務。
DescribeParameterTimedScheduleTask 查詢執行個體參數修改排程任務 查詢執行個體參數修改排程任務詳情。
ModifyParameterTimedScheduleTask 修改參數排程任務 改變參數修改排程任務中的生效時間。
DescribeDBInstanceCLS 查詢欄位加密演算法配置 查詢指定執行個體的欄位加密演算法配置資訊。
ModifyDBInstanceCLS 修改欄位加密演算法配置 修改指定執行個體的欄位加密演算法配置。
CreateRCImage 為 Custom 執行個體建立自訂映像 該介面用於為 RDS Custom 執行個體建立自訂映像。
ModifyDBInstanceVectorSupportStatus 修改執行個體向量儲存開關 打開或者關閉MySQL執行個體向量儲存開關。
DescribeImportTaskValidation 查詢匯入任務預檢查詳情 查詢匯入任務預檢查詳情,會返回具體的預檢查項目和檢查結果。
DescribeImportTask 查詢匯入任務詳情 RDS原生複製執行個體,查詢資料匯入任務詳情。
CreateImportTask 建立資料匯入任務 建立資料匯入任務。
ValidateImportTask 資料匯入任務預檢查 RDS MySQL原生複製執行個體資料匯入任務預檢查。
ListImportTasks 列表查詢資料匯入任務 列表查詢原生複製資料匯入任務。
ModifyImportTask 修改資料匯入任務 修改 RDS MySQL 原生複製執行個體資料匯入任務。
ModifyRCDiskAttribute 修改區塊儲存屬性 修改一個區塊儲存裝置的名稱、描述、是否隨執行個體釋放、是否隨磁碟刪除其自動快照、是否啟用自動快照策略、是否開啟效能突發功能等。
UpdateDBInstanceReplication 更新複製通道 原生複製執行個體更新複製通道。
CreateDBInstanceReplication 建立複製通道 原生複製執行個體建立複製鏈路。
DeleteDBInstanceReplication 刪除複製通道 刪除執行個體的原生複製鏈路。
ModifyDBInstance 修改執行個體 修改執行個體,目前僅支援 PostgreSQL 引擎。

事件與任務

API

標題

API概述

DescribeHistoryEventsStat 查詢統計歷史事件 統計事件中心的歷史事件。
DescribeHistoryEvents 查詢歷史事件 查詢事件中心的事件清單。
ModifyEventInfo 修改事件資訊 修改事件中心的事件資訊。
DescribeHistoryTasksStat 統計歷史任務 統計任務中心的任務。
DescribeHistoryTasks 查詢歷史維運任務 該介面用於取得歷史任務記錄,支援建立時間30天內的任務。
ModifyTaskInfo 修改任務資訊 修改任務中心的歷史任務資訊。
DescribeTasks 查詢RDS SQL Server任務詳情 該介面用於查詢RDS SQL Server執行個體中處於等待中和執行中的任務。