本文匯總了PolarDB-X 1.0支持的API接口。
實例管理
| API | 描述 |
|---|---|
| CreateDrdsInstance | 該接口用于創建一個PolarDB-X 1.0實例。 |
| DescribeDrdsInstance | 該接口用于查詢PolarDB-X 1.0實例詳情。 |
| DescribeDrdsInstances | 該接口用于查詢PolarDB-X 1.0實例列表。 |
| RemoveDrdsInstance | 該接口用于釋放PolarDB-X 1.0實例，只能釋放后付費實例。
說明 變配中或者有關聯數據庫未刪除的實例無法釋放。
|
| RestartDrdsInstance | 該接口用于重啟實例。 |
| ModifyDrdsInstanceDescription | 該接口用于修改實例描述。 |
| UpdateResourceGroupAttribute | 該接口用于將實例轉移至新的資源組。 |
數據庫管理
| API | 描述 |
|---|---|
| CreateDrdsDB | 該接口用于創建PolarDB-X 1.0數據庫。 |
| CheckDrdsDbName | 該接口用于檢查PolarDB-X 1.0的數據庫名是否合法。 |
| RemoveDrdsDbFailedRecord | 該接口用于刪除建庫失敗記錄。 |
| RemoveDrdsDb | 該接口用于刪除PolarDB-X 1.0下面的數據庫。 |
| DescribeDrdsShardingDbs | 該接口用于查詢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 | 該接口用于刪除實例管理賬號。 |
SQL審計
| API | 描述 |
|---|---|
| DescribeDrdsSqlAuditStatus | 該接口用于查詢PolarDB-X 1.0 SQL審計信息。 |
| EnableSqlAudit | 該接口用于開啟SQL審計功能。 |
| DescribeInstDbLogInfo | 該接口用于查詢數據庫支持導入歷史SQL數據的時間范圍。 |
| CheckSqlAuditEnableStatus | 該接口用于校驗PolarDB-X 1.0邏輯庫SQL審計是否已開啟。 |
| DescribeInstDbSlsInfo | 該接口用于查詢SQL審計時使用的SLS Project和LogStore名稱。 |
| DisableSqlAudit | 該接口用于取消SQL審計。 |
備份和恢復
| API | 描述 |
|---|---|
| StartRestore | 該接口用于啟動基于備份的恢復任務。 |
| RemoveBackupsSet | 該接口用于刪除備份集。 |
| DescribeBackMenu | 該接口用于查詢實例是否支持備份恢復。 |
| DescribeBackupTimes | 該接口用于查詢實例可恢復到的目標時間。 |
| DescribeRestoreOrder | 該接口用于查看本次恢復購買的訂單詳情。 |
| DescribeBackupDbs | 該接口用于查詢可以恢復的數據庫列表。 |
| PutStartBackup | 該接口用于提交數據備份任務。 |
| SetBackupPolicy | 該接口用于設置備份策略。 |
| EnableSqlFlashbackMatchSwitch | 該接口用于執行PolarDB-X 1.0數據庫使用存儲資源RDS的BINLOG中的QUERY信息，精確恢復數據 |
| DescribeBackupSets | 該接口用于查看備份集信息。 |
網絡和連接
| API | 描述 |
|---|---|
| UpdateInstanceNetwork | 該接口用于切換PolarDB-X 1.0實例的網絡類型。 |
| ReleaseInstanceInternetAddress | 該接口用于釋放實例外網地址，保證實例安全性。 |
| DescribeInstanceSwitchNetwork | 該接口用于查詢實例是否可以切換網絡。 |
| EnableInstanceIpv6Address | 該接口用于創建IPv6地址。 |
| CreateInstanceInternetAddress | 該接口用于為PolarDB-X 1.0實例創建公網IP。 |
| RefreshDrdsAtomUrl | 該接口用于存儲資源RDS實例連接變更后，刷新PolarDB-X 1.0分庫連接保證其到RDS的鏈路暢通。 |
擴容管理
| API | 描述 |
|---|---|
| SubmitCleanTask | 該接口用于提交平滑擴容（熱點擴容）的清理任務。 |
| SubmitSmoothExpandPreCheck | 該接口用于提交平滑擴容預檢任務。 |
| CheckExpandStatus | 該接口用于校驗PolarDB-X 1.0數據庫是否可進行平滑擴容等擴容操作。 |
| SubmitSmoothExpandTask | 該接口用于提交平滑擴容任務。 |
| SubmitSwitchTask | 該接口用于提交平滑擴容切換任務。 |
| SubmitRollbackTask | 該接口用于提交平滑擴容回滾任務。 |
任務管理
| API | 描述 |
|---|---|
| DescribeSqlFlashbakTask | 該接口用于查看閃回任務的列表。 |
| DescribeDrdsInstanceLevelTasks | 該接口用于查看閃回任務的列表。 |
| SubmitSqlFlashbackTask | 該接口用于提交SQL閃回任務。 |
| DescribePreCheckResult | 該接口用于查看任務預檢結果。 |
| DescribeDrdsTasks | 該接口用于查詢實例變更任務。 |
表拆分
| API | 描述 |
|---|---|
| ValidateShardTask | 該接口用于校驗拆分變更任務是否合法。 |
| DescribeExpandLogicTableInfoList | 該接口用于查看拆分建。 |
| DatalinkReplicationPrecheck | 該接口用于拆分任務預檢。 |
| CreateShardTask | 該接口用于創建拆分任務。 |
| DescribeShardTaskInfo | 該接口用于查看拆分變更工具詳情。 |
| DeleteShardTasks | 該接口用于刪除拆分任務。 |
廣播表
| API | 描述 |
|---|---|
| DescribeBroadcastTables | 該接口用于查詢廣播表詳情。 |
| DescribeGlobalBroadcastType | 該接口用于查詢是否為廣播表。 |
| SetupBroadcastTables | 該接口用于設置廣播表。 |
| SwitchGlobalBroadcastType | 該接口用于將廣播表從多寫切換成異步鏈路模式。 |
數據表管理
| 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。 |