全部產品
Search
文件中心

:RDS API概覽

更新時間:Jul 06, 2024

熱門API TOP 10

API

描述

CreateDBInstance

建立一個RDS執行個體。

DescribeDBInstances

查詢RDS執行個體列表或被RAM授權的執行個體列表。

DescribeDBInstanceAttribute

查詢RDS執行個體的詳細資料。

DescribeDBInstancePerformance

查詢RDS執行個體效能資料。

DescribeSlowLogRecords

查詢RDS執行個體的慢日誌明細。

DescribeSlowLogs

查詢RDS執行個體慢日誌統計情況。

DescribeBackups

查詢RDS執行個體備份組列表。

DescribeResourceUsage

查詢RDS執行個體的空間使用資訊。

CreateAccount

建立管理資料庫的帳號。

CreateDatabase

建立資料庫。

費用

API

描述

DescribePrice

查詢執行個體的價格。

DescribeRenewalPrice

查詢RDS執行個體續約的費用。

TransformDBInstancePayType

變更RDS執行個體的計費方式。

RenewInstance

手動續約RDS執行個體。

執行個體

API

描述

CreateDBInstance

建立一個RDS執行個體。

DeleteDBInstance

釋放RDS執行個體。

RestartDBInstance

重啟RDS執行個體。

ModifyDBInstanceSpec

變更RDS執行個體(包括常規執行個體和唯讀執行個體,不包括災備執行個體和臨時執行個體)的規格或儲存空間。

ModifyDasInstanceConfig

設定執行個體儲存空間自動擴容。

DescribeAvailableZones

查詢RDS可用性區域資源。

DescribeAvailableClasses

查詢執行個體可變更規格,包括規格代碼和儲存空間。

DescribeDBInstanceAttribute

查詢RDS執行個體的詳細資料。

GetDBInstanceTopology

擷取RDS執行個體的拓撲結構。

DescribeDBInstances

查詢RDS執行個體列表或被RAM授權的執行個體列表。

ListClasses

查詢RDS執行個體所有規格的詳情。

DescribeDBInstancesByExpireTime

通過到期時間查詢RDS執行個體資訊。

DescribeRegions

查詢當前可選的RDS地區和可用性區域資訊。

MigrateToOtherZone

遷移RDS執行個體至其他可用性區域。

ModifyDBInstanceDescription

修改RDS執行個體的描述。

ModifyDBInstanceMaintainTime

修改RDS執行個體可維護時間段。

CheckInstanceExist

查詢執行個體是否存在。

ModifyHADiagnoseConfig

修改阿里雲對目標RDS執行個體的可用性檢測方式。

DescribeHADiagnoseConfig

查詢阿里雲對目標RDS執行個體的可用性檢測方式。

DescribeAnalyticdbByPrimaryDBInstance

查詢RDS MySQL執行個體關聯的分析型執行個體。

CheckCloudResourceAuthorized

查詢雲資源的許可權狀態。

升級版本

API

描述

UpgradeDBInstanceEngineVersion

升級執行個體資料庫版本。

UpgradeDBInstanceKernelVersion

升級RDS執行個體的核心小版本。

ModifyDBInstanceAutoUpgradeMinorVersion

修改RDS執行個體升級核心小版本的方式。

UpgradeDBInstanceMajorVersionPrecheck

執行RDS PostgreSQL執行個體大版本升級前檢查。

DescribeUpgradeMajorVersionPrecheckTask

查詢RDS PostgreSQL執行個體大版本升級前檢查報告。

UpgradeDBInstanceMajorVersion

發起RDS PostgreSQL執行個體大版本升級。

DescribeUpgradeMajorVersionTasks

查詢RDS PostgreSQL執行個體大版本升級的歷史任務。

網路與串連地址

API

描述

AllocateInstancePublicConnection

申請RDS執行個體的外網地址。

DescribeDBInstanceNetInfo

查詢RDS執行個體的所有串連地址資訊。

ModifyDBInstanceConnectionString

修改RDS執行個體的串連地址和連接埠。

ModifyDBInstanceNetworkExpireTime

修改RDS執行個體串連地址到期時間。

SwitchDBInstanceNetType

切換RDS執行個體內外網地址。

ReleaseInstancePublicConnection

釋放RDS執行個體的外網串連地址。

ModifyDBInstanceNetworkType

切換RDS執行個體網路類型。

SwitchDBInstanceVpc

切換RDS執行個體的Virtual Private Cloud或交換器。

DescribeVSwitches

查詢Virtual Private Cloud下虛擬交換器的詳細資料。

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

API

描述

ModifyDBInstanceHAConfig

修改RDS執行個體的高可用模式和資料複製方式。

DescribeDBInstanceHAConfig

查詢RDS執行個體高可用模式和資料複製方式。

SwitchDBInstanceHA

切換RDS執行個體的主備執行個體。

ModifyHASwitchConfig

開啟或關閉RDS執行個體的主備自動切換功能。

DescribeHASwitchConfig

查詢RDS執行個體主備自動切換設定。

歷史事件

API

描述

DescribeEvents

查詢RDS事件記錄列表。

DescribeActionEventPolicy

查詢RDS歷史事件功能開啟情況。

ModifyActionEventPolicy

開啟或關閉RDS歷史事件功能。

通知

API

描述

QueryNotify

查詢RDS通知清單。

ModifyActionEventPolicy

開啟或關閉RDS歷史事件功能。

帳號

API

描述

CreateAccount

建立管理資料庫的帳號。

DeleteAccount

刪除資料庫帳號。

ResetAccountPassword

重設帳號密碼。

LockAccount

鎖定RDS PostgreSQL執行個體的帳號。

UnlockAccount

解鎖RDS PostgreSQL執行個體的帳號。

DescribeAccounts

查詢RDS執行個體的帳號資訊。

ModifyAccountDescription

修改資料庫帳號的描述。

DescribeInstanceKeywords

查詢RDS執行個體的保留關鍵字,即建立資料庫或帳號時禁用的關鍵字。

ModifyPGHbaConfig

修改RDS PostgreSQL執行個體的pg_hba.conf檔案配置。

DescribePGHbaConfig

查詢RDS PostgreSQL執行個體的pg_hba.conf檔案的配置。

DescribeModifyPGHbaConfigLog

查詢RDS PostgreSQL執行個體的pg_hba.conf檔案的修改記錄。

GrantAccountPrivilege

授權帳號訪問資料庫。

GrantOperatorPermission

授予服務帳號許可權。

RevokeOperatorPermission

撤銷服務帳號許可權。

RevokeAccountPrivilege

撤銷帳號對資料庫的存取權限。

ResetAccount

重設高許可權帳號的許可權。

資料庫

API

描述

CreateDatabase

建立資料庫。

DeleteDatabase

刪除RDS執行個體下的某個資料庫。

ModifyDBDescription

修改資料庫備忘。

CopyDatabaseBetweenInstances

在RDS執行個體間複製資料庫。

DescribeDatabases

查詢RDS執行個體下的資料庫資訊。

CheckDBNameAvailable

檢查資料庫名稱是否可用。

DescribeCollationTimeZones

查詢支援的字元集定序和時區。

DescribeCharacterSetName

查詢RDS執行個體支援的字元集。

唯讀執行個體

API

描述

CreateReadOnlyDBInstance

為某個RDS執行個體建立一個唯讀執行個體。

DescribeReadDBInstanceDelay

查詢RDS唯讀執行個體的延遲資訊。

ModifyReadonlyInstanceDelayReplicationTime

修改RDS唯讀執行個體的延遲複製時間。

叢集系列執行個體

API

描述

CreateDBNodes

新增叢集系列執行個體節點。

DeleteDBNodes

刪除叢集系列執行個體節點。

DescribeDBInstanceEndpoints

查詢執行個體的Endpoint資訊。

CreateDBInstanceEndpoint

建立執行個體的Endpoint。

DeleteDBInstanceEndpoint

刪除執行個體的Endpoint。

ModifyDBInstanceEndpoint

修改執行個體Endpoint資訊。

CreateDBInstanceEndpointAddress

建立執行個體外網串連地址。

DeleteDBInstanceEndpointAddress

刪除執行個體的外網串連地址。

ModifyDBInstanceEndpointAddress

修改執行個體的Endpoint串連地址。

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

API

描述

AllocateReadWriteSplittingConnection

申請讀寫分離地址。

ReleaseReadWriteSplittingConnection

釋放讀寫分離地址。

CalculateDBInstanceWeight

查詢系統權重分配值。

ModifyReadWriteSplittingConnection

修改讀寫分離鏈路的延遲閾值和各個執行個體的讀權重。

DescribeDBInstanceProxyConfiguration

查詢資料庫代理設定。

資料庫獨享代理(讀寫分離)

API

描述

ModifyDBProxy

開啟或者關閉RDS執行個體的資料庫獨享代理功能。

UpgradeDBProxyInstanceKernelVersion

升級獨享代理核心小版本。

ModifyDBProxyInstance

修改RDS資料庫獨享代理數量。

ModifyDBProxyEndpoint

修改RDS執行個體資料庫獨享代理的串連地址配置(讀寫分離、事務拆分、串連池)。

DescribeDBProxy

查詢RDS執行個體的資料庫獨享代理詳情。

DescribeDBProxyEndpoint

查詢RDS執行個體獨享代理的串連地址資訊。

DescribeDBProxyPerformance

查詢獨享代理的效能資料。

CreateDBProxyEndpointAddress

建立RDS執行個體獨享代理的串連地址。

ModifyDBProxyEndpointAddress

修改RDS執行個體獨享代理的串連地址。

DeleteDBProxyEndpointAddress

刪除RDS執行個體獨享代理的串連地址。

ModifyDbProxyInstanceSsl

設定RDS執行個體獨享代理串連地址SSL加密。

GetDbProxyInstanceSsl

查詢RDS執行個體獨享代理串連地址SSL加密資訊。

安全加密

API

描述

DescribeSecurityGroupConfiguration

查詢指定RDS執行個體和ECS安全性群組的關聯資訊。

ModifySecurityGroupConfiguration

修改指定RDS執行個體和ECS安全性群組的關聯資訊。

DescribeDBInstanceIPArrayList

查詢RDS執行個體IP白名單。

ModifySecurityIps

修改IP白名單。

DescribeDBInstanceSSL

查詢RDS執行個體SSL設定。

ModifyDBInstanceSSL

修改RDS執行個體SSL鏈路。

DescribeDBInstanceTDE

查詢RDS執行個體資料加密狀態。

ModifyDBInstanceTDE

開啟RDS執行個體透明資料加密功能。

MigrateSecurityIPMode

白名單從通用模式切換為高安全模式。

DescribeDBInstanceIpHostname

查詢RDS執行個體的底層ECS執行個體的hostname。

DescribeDTCSecurityIpHostsForSQLServer

查詢RDS執行個體的分散式交易白名單資訊。

ModifyDTCSecurityIpHostsForSQLServer

設定分散式交易白名單。

DescribeDBInstanceEncryptionKey

查詢RDS執行個體的雲端硬碟加密狀態及密鑰詳情。

CreateServiceLinkedRole

建立服務關聯角色(SLR)。

ModifyDBInstanceDeletionProtection

開啟或關閉RDS執行個體的釋放保護功能。

日誌

API

描述

ModifySQLCollectorPolicy

開啟或關閉執行個體的SQL洞察(SQL審計)功能。

DescribeSQLCollectorPolicy

查詢RDS執行個體的SQL審計或SQL洞察功能是否開啟。

DescribeSQLLogRecords

查詢RDS執行個體的SQL洞察(SQL審計)日誌。

DescribeSQLLogFiles

查詢SQL洞察(SQL審計)檔案清單。

ModifySQLCollectorRetention

修改RDS執行個體的SQL洞察日誌儲存時間長度。

DescribeSQLCollectorRetention

查詢RDS執行個體的SQL洞察日誌儲存時間長度。

DescribeSlowLogs

查詢慢日誌統計情況。

DescribeSlowLogRecords

查詢RDS執行個體的慢日誌明細。

DescribeErrorLogs

查詢RDS執行個體某段時間內的錯誤記錄檔。

PurgeDBInstanceLog

清理或收縮RDS執行個體日誌。

DescribeSQLLogReports

查詢執行個體的SQL日誌運行報告。

DescribeSQLLogReportList

查看執行個體的SQL日誌運行報告列表。

備份

API

描述

CreateBackup

建立一個備份組。

DescribeBackups

查詢備份組列表。

DescribeDetachedBackups

查看已刪除執行個體的備份組列表。

DescribeBackupPolicy

查詢RDS執行個體備份設定。

ModifyBackupPolicy

修改備份設定。

DeleteBackup

刪除資料備份檔案。

DescribeBackupTasks

查詢RDS執行個體的備份工作清單。

DescribeBinlogFiles

查詢Binlog日誌。

恢複

API

描述

RecoveryDBInstance

恢複資料庫。

CloneDBInstance

將歷史資料恢複至一個新執行個體(稱為複製執行個體)。

CreateTempDBInstance

建立臨時執行個體。

DescribeLocalAvailableRecoveryTime

查詢RDS執行個體備份可恢複的時間範圍。

RestoreTable

恢複RDS執行個體的某些資料庫或表到原執行個體。

DescribeMetaList

查詢目標備份組中可恢複的庫表資訊。

跨地區備份恢複

API

描述

CheckCreateDdrDBInstance

預檢查某RDS執行個體是否可以用跨地區備份組進行跨地區恢複。

CreateDdrInstance

跨地區恢複資料到新執行個體。

RestoreDdrTable

跨地區恢複資料到已有執行個體。

ModifyInstanceCrossBackupPolicy

修改RDS跨地區備份設定。

DescribeInstanceCrossBackupPolicy

查詢跨地區備份設定。

DescribeCrossBackupMetaList

查詢跨地區備份的庫表資訊。

DescribeCrossRegionBackups

查詢某RDS執行個體跨地區資料備份檔案清單。

DescribeCrossRegionLogBackupFiles

查詢跨地區記錄備份檔案清單。

DescribeAvailableCrossRegion

查詢所選地區當前可以進行跨地區備份的目的地區。

DescribeAvailableRecoveryTime

查詢某跨地區備份檔案可恢複哪個時間段的資料。

DescribeCrossRegionBackupDBInstance

查詢所選地區的哪些執行個體開啟了跨地區備份,以及這些執行個體的跨地區備份設定。

監控

API

描述

DescribeResourceUsage

查詢執行個體的空間使用資訊。

DescribeDBInstancePerformance

查詢執行個體效能資料。

DescribeDBInstanceMonitor

查詢監控頻率。

ModifyDBInstanceMonitor

修改監控頻率。

DescribeAvailableMetrics

擷取RDS PostgreSQL執行個體支援的所有增強監控指標。

ModifyDBInstanceMetrics

變更RDS PostgreSQL執行個體需要展示的增強監控指標。

DescribeDBInstanceMetrics

查詢RDS PostgreSQL執行個體已開啟的增強指標。

參數

API

描述

DescribeParameters

查詢執行個體當前的參數配置。

ModifyParameter

修改執行個體參數。

DescribeModifyParameterLog

查詢RDS執行個體的參數修改日誌。

DescribeParameterTemplates

查詢資料庫參數模板。

CreateParameterGroup

建立RDS參數模板。

ModifyParameterGroup

修改RDS參數模板。

CloneParameterGroup

複製RDS參數模板到當前地區或其他地區內。

DescribeParameterGroups

查詢目標地區的參數模板列表。

DescribeParameterGroup

查詢指定的RDS參數模板資訊。

DeleteParameterGroup

刪除RDS參數模板。

資料移轉

API

描述

ImportDatabaseBetweenInstances

從其它RDS執行個體遷入資料。

CancelImport

取消RDS SQL Server執行個體遷移任務。

SQL Server備份檔案上雲

API

描述

CreateMigrateTask

將OSS上的備份檔案還原到RDS執行個體,實現資料上雲。

DescribeMigrateTasks

查詢備份資料上雲工作清單。

DescribeOssDownloads

查詢備份資料上雲任務的檔案詳情。

CreateOnlineDatabaseTask

開啟RDS SQL Server備份資料上雲任務的資料庫。

DescribeMigrateTaskById

查詢SQL Server的某個OSS備份上雲任務的資訊。

TerminateMigrateTask

終止RDS執行個體遷移任務。

SQL Server AD域

API

描述

ModifyADInfo

修改RDS SQL Server執行個體的AD域資訊。

DeleteADSetting

移除RDS SQL Server執行個體的AD域資訊。

DescribeADInfo

查詢RDS SQL Server執行個體的AD域資訊。

SQL Server叢集管理

API

描述

AllocateReadWriteSplittingConnection

申請RDS執行個體的讀寫分離地址。

ReleaseReadWriteSplittingConnection

釋放RDS執行個體的讀寫分離地址。

CalculateDBInstanceWeight

查詢系統權重分配值。

ModifyReadWriteSplittingConnection

修改讀寫分離鏈路的延遲閾值和各個執行個體的讀權重。

PostgreSQL一鍵上雲

API

描述

CreateCloudMigrationPrecheckTask

建立RDS PostgreSQL一鍵上雲前檢查任務。

DescribeCloudMigrationPrecheckResult

查詢一鍵上雲前檢查報告。

CreateCloudMigrationTask

建立RDS PostgreSQL遷移上雲任務。

ActivateMigrationTargetInstance

執行RDS PostgreSQL上雲切換,將RDS PostgreSQL提升為主庫,正式提供服務。

DescribeCloudMigrationResult

查詢RDS PostgreSQL遷移上雲任務詳情。

標籤

API

描述

TagResources

為指定的RDS執行個體建立並綁定標籤。

UntagResources

為指定的RDS執行個體解除綁定標籤。

ListTagResources

查詢一個或多個RDS執行個體已經綁定的標籤列表。