全部產品
Search

搜尋本產品

    ：API概覽

    文件中心

    ：API概覽

    更新時間：Apr 08, 2025

    雲資料庫RDS提供以下相關API介面。

    熱門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描述
    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執行個體已經綁定的標籤列表。