全部產品
Search
文件中心

PolarDB:API概覽

更新時間:Jul 06, 2024

本文匯總了PolarDB-X 1.0支援的API介面。

執行個體管理

API描述
CreateDrdsInstance該介面用於建立一個PolarDB-X 1.0執行個體。
DescribeDrdsInstance該介面用於查詢PolarDB-X 1.0執行個體詳情。
DescribeDrdsInstances該介面用於查詢PolarDB-X 1.0執行個體列表。
RestartDrdsInstance該介面用於重啟執行個體。
ModifyDrdsInstanceDescription該介面用於修改執行個體描述。
UpdateResourceGroupAttribute該介面用於將執行個體轉移至新的資源群組。

資料庫管理

API描述
CreateDrdsDB該介面用於建立PolarDB-X 1.0資料庫。
CheckDrdsDbName該介面用於檢查PolarDB-X 1.0的資料庫名是否合法。
RemoveDrdsDbFailedRecord該介面用於刪除建庫失敗記錄。
RemoveDrdsDb該介面用於刪除PolarDB-X 1.0下面的資料庫。
DescribeDrdsDB該介面用於查詢執行個體下的目標資料庫詳情。
DescribeDrdsDBs該介面用於查詢PolarDB-X 1.0執行個體下所有資料庫資訊。

儲存管理

API描述
DescribeRdsPerformanceSummary該介面用於查看儲存資源RDS的相關效能。
DescribeRdsSuperAccountInstances該介面用於擷取儲存資源RDS高許可權帳號。
DescribeDrdsDBCluster該介面用於查詢PolarDB-X 1.0邏輯庫下PolarDB叢集具體資訊。
DescribeDrdsDbInstance該介面用於查詢PolarDB-X 1.0的儲存資源RDS執行個體詳情。
DescribeDrdsDbInstances該介面用於查詢PolarDB-X 1.0資料庫下面的RDS列表。
DescribeDrdsDbRdsNameList該介面用於查詢PolarDB-X 1.0資料庫儲存執行個體列表。
GetDrdsDbRdsRelationInfo該介面用於查詢PolarDB-X 1.0資料庫儲存執行個體結構。
ModifyRdsReadWeight該介面用於修改儲存資源RDS的讀寫權重。
ModifyPolarDbReadWeight該介面用於修改儲存資源PolarDB的讀寫權重。
ResetDrdsToRdsConnections該介面用於重設後端PolarDB-X 1.0到儲存資源RDS串連數。
DescribeRDSPerformance該介面用於查看儲存資源RDS效能資料。
DescribeDbInstances該介面用於查看儲存層(如RDS或PolarDB)執行個體列表。
DescribeDbInstanceDbs該介面用於查看某個儲存執行個體下的資料庫列表。
DescribeStorageInstanceSubDbInfo該介面用於擷取儲存執行個體。
DescribeRdsCommodity該介面用於查看儲存資源RDS售賣資料。

帳號管理

API描述
CreateInstanceAccount該介面用於建立PolarDB-X 1.0執行個體級帳號。
DescribeInstanceAccounts該介面用於查看執行個體帳號資訊。
RemoveInstanceAccount該介面用於刪除執行個體管理帳號。

備份和恢複

API描述
StartRestore該介面用於啟動基於備份的恢複任務。
RemoveBackupsSet該介面用於刪除備份組。
DescribeBackMenu該介面用於查詢執行個體是否支援備份恢複。
DescribeBackupTimes該介面用於查詢執行個體可恢複到的目標時間。
DescribeRestoreOrder該介面用於查看本次恢複購買的訂單詳情。
DescribeBackupDbs該介面用於查詢可以恢複的資料庫列表。
PutStartBackup該介面用於提交資料備份任務。
SetBackupPolicy該介面用於設定備份策略。
EnableSqlFlashbackMatchSwitch該介面用於執行PolarDB-X 1.0資料庫使用儲存資源RDS的BINLOG中的QUERY資訊,精確恢複資料
DescribeBackupSets該介面用於查看備份組資訊。

網路和串連

API描述
ReleaseInstanceInternetAddress該介面用於釋放執行個體外網地址,保證執行個體安全性。
DescribeInstanceSwitchNetwork該介面用於查詢執行個體是否可以切換網路。
CreateInstanceInternetAddress該介面用於為PolarDB-X 1.0執行個體建立公網IP。
RefreshDrdsAtomUrl該介面用於儲存資源RDS執行個體串連變更後,重新整理PolarDB-X 1.0分庫串連保證其到RDS的鏈路暢通。

任務管理

API描述
DescribeSqlFlashbakTask該介面用於查看閃回任務的列表。
DescribeDrdsInstanceLevelTasks該介面用於查看閃回任務的列表。
SubmitSqlFlashbackTask該介面用於提交SQL閃回任務。
DescribePreCheckResult該介面用於查看任務預檢結果。
DescribeDrdsTasks該介面用於查詢執行個體變更任務。

表拆分

API描述
ValidateShardTask該介面用於校正拆分變更任務是否合法。
DescribeExpandLogicTableInfoList該介面用於查看拆分建。
DatalinkReplicationPrecheck該介面用於分割任務預檢。
CreateShardTask該介面用於建立分割任務。
DescribeShardTaskInfo該介面用於查看拆分變更工具詳情。
DeleteShardTasks該介面用於刪除分割任務。

資料表管理

API描述
DescribeTables該介面用於擷取表資訊列表。
DescribeTableListByType該介面用於根據類型擷取表集合。
DescribeTable該介面用於擷取表結構資訊。
SetupTable該介面用於設定表全表掃描。

標籤和參數設定

API描述
TagResources該介面用於為執行個體打標籤。
UntagResources該介面用於取消執行個體的標籤。
ListTagResources該介面用於查看執行個體的標籤。
DescribeDrdsParams該介面用於查詢PolarDB-X 1.0的參數列表。
SetupDrdsParams該介面用於設定PolarDB-X 1.0參數。

執行個體版本

API描述
DescribeDrdsInstanceVersion該介面用於查詢PolarDB-X 1.0執行個體版本。
RollbackInstanceVersion該介面用於復原PolarDB-X 1.0執行個體的版本。
UpgradeInstanceVersion該介面用於升級PolarDB-X 1.0執行個體的版本 。

效能監控

API描述
DescribeDrdsInstanceMonitor該介面用於查詢PolarDB-X 1.0執行個體監控資料。
DescribeDrdsInstanceDbMonitor該介面用於查詢PolarDB-X 1.0資料庫的效能監控資料。

其它

API描述
DescribeDrdsDBIpWhiteList該介面用於查看資料庫IP白名單列表。
ModifyDrdsIpWhiteList該介面用於修改PolarDB-X 1.0資料庫白名單。
DescribeInstanceSwitchAzone該介面用於查看目標執行個體是否支援切換可用性區域。
DescribeDrdsSlowSqls該介面用於查看PolarDB-X 1.0慢SQL。