全部產品
Search
文件中心

ApsaraDB RDS:API概覽

更新時間:Apr 30, 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或RDS PostgreSQL執行個體升級小版本的方式。
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執行個體的Virtual Private Cloud和交換器。
ModifyDBInstanceConfig 修改RDS執行個體的配置項 該介面用於修改RDS執行個體的配置項。
DescribeDBInstanceNetInfo 查詢執行個體的所有串連地址資訊 該介面用於查詢RDS執行個體的所有串連地址資訊。
DescribeVSwitches 查詢虛擬交換器列表 該介面用於查詢Virtual Private Cloud下虛擬交換器的詳細資料。

主備高可用和資料複製方式

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 修改資料庫帳號的備忘資訊 該介面用於修改資料庫帳號的描述資訊。
ModifyPGHbaConfig 修改RDS PostgreSQL執行個體pg_hba.conf檔案配置 該介面用於修改RDS PostgreSQL執行個體的pg_hba.conf檔案配置。
DescribeAccounts 查詢資料庫帳號資訊 該介面用於查詢RDS執行個體的帳號資訊。
DescribeInstanceKeywords 擷取執行個體的保留關鍵詞資訊 該介面用於查詢RDS執行個體的保留關鍵字,即建立資料庫或帳號時禁用的關鍵字。
DescribePGHbaConfig 查詢RDS PostgreSQL執行個體pg_hba.conf檔案配置 該介面用於查詢RDS PostgreSQL執行個體的pg_hba.conf檔案的配置。
DescribeModifyPGHbaConfigLog 查詢RDS PostgreSQL執行個體pg_hba.conf檔案修改記錄 該介面用於查詢RDS PostgreSQL執行個體的pg_hba.conf檔案的修改記錄。
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概述

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 取消主動營運任務 該介面用於取消尚未開始的營運任務。

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。

承諾型Serverless

API

標題

API概述

ModifyComputeBurstConfig 修改或關閉承諾型Serverless功能 調用該介面,修改或關閉承諾型Serverless功能。
DescribeComputeBurstConfig 查詢承諾型Serverless功能配置 查詢承諾型Serverless功能的配置。

其他

API

標題

API概述

使用者憑證 使用者憑證
CreateSecret 建立使用者憑證 該介面用於建立Data API使用者憑證。
DeleteSecret 刪除使用者憑證 調用DeleteSecret介面刪除Data API使用者憑證。
DescribeSecrets 查詢使用者憑證 該介面用於查詢Data API使用者憑證。
主機 主機
DescribeDedicatedHostGroups 查詢RDS主機群組資訊 查詢RDS專屬叢集資訊。
DescribeDedicatedHosts 查詢RDS主機群組內的主機資訊 查詢專屬叢集內的主機資訊。
MigrateDBInstance 遷移主機群組內的RDS執行個體 調用MigrateDBInstance介面遷移專屬叢集內的RDS執行個體。
RebuildDBInstance 將RDS主機群組內執行個體的備執行個體重建 調用RebuildDBInstance介面重建專屬叢集中的RDS備執行個體。
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 校正備份加密 為使用者建立備份Data Encryption Service關聯角色 AliyunServiceRoleForRdsBackupEncryption
CheckBackupEncryptionAuthorized 查詢備份加密校正結果 檢查使用者帳號下是否已經建立備份Data Encryption Service關聯角色 AliyunServiceRoleForRdsBackupEncryption
CheckRegionSupportBackupEncryption 檢查單元是否支援備份加密 檢查當前region是否支援備份加密
DescribeSQLServerUpgradeVersions 查詢SQLServer可升級版本 描述SQLServer執行個體或指定SQLServer版本允許升級到的版本。
DescribeVpcs 查詢Virtual Private Cloud列表 用於查詢阿里雲賬戶下的Virtual Private Cloud列表資訊。
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 修改Block Storage屬性 修改一個Block Storage裝置的名稱、描述、是否隨執行個體釋放、是否隨磁碟刪除其自動快照、是否啟用自動快照策略、是否開啟效能突發功能等。
UpdateDBInstanceReplication 更新複製通道 原生複製執行個體更新複製通道
CreateDBInstanceReplication 建立複製通道 原生複製執行個體建立複製鏈路
DeleteDBInstanceReplication 刪除複製通道 原生複製執行個體刪除複製鏈路
ModifyDBInstance 修改執行個體 修改執行個體,目前僅支援PostgreSQL引擎。

事件與任務

API

標題

API概述

DescribeHistoryEventsStat 查詢統計歷史事件 統計事件中心的歷史事件。
DescribeHistoryEvents 查詢歷史事件 查詢事件中心的事件列表。
ModifyEventInfo 修改事件資訊 修改事件中心的事件資訊。
DescribeHistoryTasksStat 統計歷史任務 統計工作中樞的任務。
DescribeHistoryTasks 查詢歷史營運任務 該介面用於擷取歷史任務記錄,支援建立時間30天內的任務。
ModifyTaskInfo 修改任務資訊 修改工作中樞的歷史任務資訊。

控制台介面

API

標題

API概述

CreateYouhuiForOrder 領取優惠券 該介面用於領取優惠券。
DescribeCurrentModifyOrder 查詢執行個體最新變更配置訂單 查詢執行個體最新變更配置訂單
DescribeCustinsResourceInfo 查詢執行個體資源使用方式 查詢執行個體資源使用方式
DescribeDBInstanceConnectivity 查詢資料庫執行個體串連 擷取執行個體鏈路診斷資訊
DescribeHostGroupElasticStrategyParameters 查詢主機群組彈性策略配置 查詢主機群組彈性策略參數
DescribeMarketingActivity 查詢營銷活動 擷取RDS營銷專案中待升級執行個體資訊
DescribeQuickSaleConfig 查詢快捷售賣商品配置 查詢RDS快捷售賣配置
DescribeResourceDetails 查詢資來源詳細資料 概覽頁資源詳情
EvaluateLocalExtendDisk 評估本地擴充磁碟 評估緊急本地擴容磁碟解鎖可使用的磁碟空間
ModifyCustinsResource 修改執行個體資源 該介面用於修改RDS執行個體資源。
PreCheckCreateOrderForDeleteDBNodes 刪除執行個體節點預檢查 刪除節點建立訂單預檢查
QueryRecommendByCode 查詢RDS熱點問題 該介面用於查詢RDS機器人熱點問題。
CreateOrderForDeleteDBNodes 刪除執行個體節點 該介面用於為RDS MySQL叢集系列執行個體刪除節點。