全部產品

PolarDB：API概覽

更新時間：Jul 06, 2024

雲原生資料庫PolarDB提供以下相關API介面。

地區

API	描述
DescribeRegions	該介面用於查詢PolarDB支援的地區和可用性區域。

叢集

類別	API	描述
叢集管理	CreateDBCluster	該介面用於建立PolarDB叢集。
	DeleteDBCluster	該介面用於釋放隨用隨付的PolarDB叢集。
	DescribeDBClusters	該介面用於查詢PolarDB叢集列表或被RAM授權的叢集列表。
	DescribeDBClusterAttribute	該介面用於查詢指定PolarDB叢集的詳細屬性。
	ModifyDBClusterMaintainTime	該介面用於修改PolarDB叢集可例行維護的時間，一般設定為業務的低峰時間段。阿里雲會在您設定的可維護時間段內進行叢集維護，保證對業務的影響降到最低。
	ModifyDBClusterDescription	該介面用於修改PolarDB叢集名稱，方便叢集的維護。
	DescribeTasks	該介面用於查看通過API產生的任務（如建立叢集）進度詳情。
部署架構	ModifyDBClusterPrimaryZone	該介面用於變更PolarDB叢集的主可用性區域。
部署架構	FailoverDBCluster	該介面用於手動對PolarDB叢集進行主備切換，可以指定一個唯讀節點為新的主節點。
續約管理	DescribeAutoRenewAttribute	該介面用於查詢PolarDB訂用帳戶叢集自動續約狀態。
	ModifyAutoRenewAttribute	該介面用於設定PolarDB訂用帳戶叢集自動續約狀態。
	DescribeDBClusterAvailableResources	該介面用於查詢PolarDB叢集可售賣資源。

資料安全

類別	API	描述
白名單	ModifyDBClusterAccessWhitelist	該介面用於建立或修改PolarDB叢集的白名單（包括IP白名單和安全性群組）。
白名單	DescribeDBClusterAccessWhitelist	該介面用於查詢允許訪問PolarDB叢集的IP白名單和安全性群組。
SSL加密	ModifyDBClusterSSL	該介面用於設定PolarDB叢集SSL加密的開通、關閉或更新CA認證。
SSL加密	DescribeDBClusterSSL	該介面用於查詢PolarDB叢集SSL設定。

節點

API	描述
CreateDBNodes	該介面用於增加PolarDB叢集的唯讀節點。
ModifyDBNodeClass	該介面用於變更PolarDB叢集節點規格。
RestartDBNode	該介面用於重啟PolarDB叢集節點。
DeleteDBNodes	該介面用於刪除PolarDB叢集節點。

叢集參數

API	描述
DescribeDBClusterParameters	該介面用於查詢PolarDB叢集的參數。
ModifyDBClusterParameters	該介面用於修改PolarDB叢集的參數。

訪問地址

API	描述
CreateDBEndpointAddress	該介面用於建立PolarDB叢集的公網地址，包括主地址、預設叢集地址和自訂叢集地址的公網地址。
CreateDBClusterEndpoint	該介面用於建立PolarDB自訂叢集地址。
DescribeDBClusterEndpoints	該介面用於查詢PolarDB叢集的地址資訊。
ModifyDBClusterEndpoint	該介面用於修改PolarDB的叢集地址屬性，包括讀寫入模式、新節點是否自動加入本地址、一致性層級等。
ModifyDBEndpointAddress	該介面用於修改PolarDB叢集公網地址，包括主地址、預設叢集地址和自訂叢集地址的公網地址。
DeleteDBEndpointAddress	該介面用於釋放PolarDB叢集的公網地址，包括主地址的公網連結、叢集地址的公網連結以及自訂的叢集地址的公網連結。
DeleteDBClusterEndpoint	該介面用於釋放PolarDB自訂叢集地址。

日誌

API	描述
DescribeDBClusterAuditLogCollector	該介面用於查詢PolarDB叢集的SQL採集功能是否開啟，SQL採集包括審計日誌、SQL洞察等功能。
ModifyDBClusterAuditLogCollector	該介面用於開啟或關閉PolarDB叢集的SQL採集功能，SQL採集包括審計日誌、SQL洞察等功能。

帳號

API	描述
CreateAccount	該介面用於為PolarDB資料庫建立帳號。
DescribeAccounts	該介面用於查詢PolarDB叢集的資料庫帳號資訊。
CheckAccountName	該介面用於校正帳號名稱是否合法或當前叢集中是否已存在重名的帳號。
ModifyAccountDescription	該介面用於修改PolarDB資料庫帳號的備忘資訊。
ModifyAccountPassword	該介面用於修改PolarDB資料庫的帳號密碼。
DeleteAccount	該介面用於刪除PolarDB資料庫帳號。

資料庫

API	描述
CreateDatabase	該介面用於在PolarDB叢集下建立一個新的資料庫。
DescribeDatabases	該介面用於查詢PolarDB指定叢集的資料庫列表資訊。
DeleteDatabase	該介面用於刪除PolarDB叢集下的資料庫。
DescribeDBInitializeVariable	該介面用於查看PolarDB PostgreSQL版（相容Oracle）資料庫支援的字元集、定序等屬性。
CheckDBName	該介面用於校正資料庫名稱是否合法或當前叢集中是否已存在重名的資料庫名稱。

DBLink

API	描述
CreateDBLink	該介面用於建立PolarDB PostgreSQL版（相容Oracle）叢集的DBLink。
DescribeDBLinks	該介面用於查詢PolarDB PostgreSQL版（相容Oracle）叢集的DBLink資訊。
DeleteDBLink	該介面用於刪除PolarDB PostgreSQL版（相容Oracle）的叢集的DBLink。

備份

類別	API	描述
備份管理	CreateBackup	該介面用於手動為PolarDB叢集建立全量快照備份。
	DescribeBackups	該介面用於查詢PolarDB叢集的備份資訊。
	DescribeBackupTasks	該介面用於查詢PolarDB叢集的備份工作清單。
	DescribeBackupLogs	該介面用於查詢備份日誌列表、擷取備份日誌下載地址。
	DescribeDetachedBackups	該介面用於查詢已被釋放的PolarDB叢集中備份組的資訊。
	DescribeDBClustersWithBackups	該介面用於查詢某地區下包含備份組的PolarDB叢集詳情。
	DeleteBackup	該介面用於刪除PolarDB叢集的備份。
備份策略	DescribeBackupPolicy	該介面用於查詢自動備份策略。
	DescribeLogBackupPolicy	該介面用於查詢PolarDB叢集記錄備份的保留原則。
	ModifyBackupPolicy	該介面用於修改自動備份策略。
	ModifyLogBackupPolicy	該介面用於修改PolarDB叢集的記錄備份保留原則。

標籤

API	描述
TagResources	該介面用於為PolarDB叢集綁定標籤。
UntagResources	該介面用於將標籤從PolarDB叢集上解除綁定。
ListTagResources	該介面用於查詢一個或多個PolarDB叢集已綁定的標籤列表，或者查詢一個或多個標籤綁定的PolarDB叢集列表。

待處理事件

API	描述
DescribePendingMaintenanceAction	該介面用於查詢待處理事件的詳情。
DescribePendingMaintenanceActions	該介面用於查詢不同任務類型下待處理事件的數量。
ModifyPendingMaintenanceAction	該介面用於修改待處理事件的任務切換時間。

定時任務

API	描述
DescribeScheduleTasks	該介面用於查詢當前帳號下所有或指定的定時任務詳情。
CancelScheduleTasks	該介面用於取消目標定時任務。

監控

API	描述
DescribeDBNodePerformance	該介面用於查詢PolarDB叢集節點的效能資料。
DescribeDBClusterPerformance	該介面用於查詢PolarDB叢集的效能資料。
DescribeDBClusterMonitor	該介面用於查詢PolarDB叢集的監控資料擷取頻率。
ModifyDBClusterMonitor	該介面用於修改PolarDB叢集的監控資料擷取頻率。