本產(chǎn)品（
云數(shù)據(jù)庫 PolarDB/2017-08-01）的OpenAPI采用RPC簽名風格，簽名細節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調用本產(chǎn)品OpenAPI而無需關心技術細節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節(jié)非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節(jié)請參見獲取AccessKey。
售賣管理
| API | 標題 | API概述 |
|---|---|---|
| CreateStoragePlan | 新建存儲計劃 | 購買存儲包。 |
| DescribeAutoRenewAttribute | 查詢集群自動續(xù)費狀態(tài) | 查詢PolarDB包年包月集群自動續(xù)費狀態(tài)。 |
| DescribeClassList | 查詢polardb集群的規(guī)格列表 | 查看集群規(guī)格列表。 |
| DescribeDBClusterAvailableResources | 查詢PolarDB集群可售賣資源 | 查詢PolarDB集群可售賣資源。 |
| EvaluateRegionResource | 資源評估 | 進行資源評估。 |
| ModifyAutoRenewAttribute | 設置包年包月集群自動續(xù)費狀態(tài) | 設置PolarDB包年包月集群自動續(xù)費狀態(tài)。 |
| TransformDBClusterPayType | 變更數(shù)據(jù)庫集群付費類型 | 變更PolarDB集群的計費方式。 |
集群管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDBCluster | 創(chuàng)建集群 | CreateDBCluster。 |
| DeleteDBCluster | 釋放按量付費的PolarDB集群 | 釋放按量付費的PolarDB集群。 |
| DescribeDBClusters | 查詢集群列表 | 查詢PolarDB集群列表或被RAM授權的集群列表詳情。 |
| DescribeDBClusterAttribute | 查看PolarDB集群的詳細屬性 | 查看集群屬性信息。 |
| DescribeDBClusterServerlessConf | 查詢Serverless集群的配置 | 查詢serverless配置。 |
| DescribePolarSQLCollectorPolicy | 查詢集群SQL洞察功能 | 查看目標集群的SQL洞察功能是否已開啟。 |
| DescribeRegions | 查看用戶可選的地域和可用區(qū) | 查詢PolarDB支持的地域和可用區(qū)。 |
| DescribeTasks | 獲取任務列表 | 查看通過API生成的任務（如創(chuàng)建集群）進度詳情。 |
| DescribeVSwitches | 查詢已創(chuàng)建的交換機 | 查詢交換機。 |
| ModifyDBCluster | 修改集群功能配置 | 修改PolarDB MySQL集群的功能配置。 |
| ModifyDBClusterDescription | 修改集群名稱 | 修改PolarDB集群名稱。 |
| ModifyDBClusterDeletion | 開啟或者關閉集群保護鎖 | 開啟或者關閉集群保護鎖。 |
| ModifyDBClusterMaintainTime | 修改實例集群可維護時間段 | 修改PolarDB集群可例行維護的時間。 |
| EnableDBClusterServerless | 開啟穩(wěn)態(tài)Serverless | 開啟穩(wěn)態(tài)Serverless。 |
| DisableDBClusterServerless | 關閉穩(wěn)態(tài)Serverless | 關閉穩(wěn)態(tài)Serverless。 |
| ModifyDBClusterServerlessConf | 修改Serverless集群配置 | 修改Serverless集群配置。 |
| ModifyDBClusterStorageSpace | 變更企業(yè)版按空間計費集群和標準版集群的存儲空間 | 變更企業(yè)版按空間計費集群和標準版集群的存儲空間。 |
| ManuallyStartDBCluster | 手動啟動集群 | 手動啟動集群。 |
高可用部署架構
| API | 標題 | API概述 |
|---|---|---|
| ModifyDBClusterPrimaryZone | 更換PolarDB集群的可用區(qū) | 更換PolarDB集群的可用區(qū)。 |
| FailoverDBCluster | 對集群進行手動主備切換 | 對PolarDB集群進行手動主備切換，可以指定一個只讀節(jié)點為新的主節(jié)點。 |
內核版本管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterVersion | 查看PolarDB MySQL集群內核版本信息 | 查看PolarDB MySQL集群當前內核版本的詳細信息。 |
| UpgradeDBClusterVersion | 升級PolarDB MySQL版集群的內核版本 | 升級PolarDB MySQL版集群的內核版本。 |
白名單管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterAccessWhitelist | 查看集群的IP白名單 | 查看允許訪問數(shù)據(jù)庫集群的IP白名單和安全組。 |
| ModifyDBClusterAccessWhitelist | 創(chuàng)建或修改集群的白名單 | 創(chuàng)建或修改集群的白名單（包括IP白名單和安全組）。 |
全局IP白名單模板管理
| API | 標題 | API概述 |
|---|---|---|
| CreateGlobalSecurityIPGroup | 創(chuàng)建全局白名單 | 創(chuàng)建全局IP白名單模板。 |
| DeleteGlobalSecurityIPGroup | 刪除全局白名單 | 刪除全局IP白名單模板。 |
| DescribeGlobalSecurityIPGroup | 查詢全局IP白名單模板列表 | 查詢全局IP白名單模板列表。 |
| DescribeGlobalSecurityIPGroupRelation | 查詢關聯(lián)關系 | 查詢集群與全局IP白名單模板的關聯(lián)關系。 |
| ModifyGlobalSecurityIPGroup | 修改全局白名單 | 修改IP白名單模板。 |
| ModifyGlobalSecurityIPGroupName | 修改全局白名單名稱 | 修改全局IP白名單模板名稱。 |
| ModifyGlobalSecurityIPGroupRelation | 修改全局白名單關聯(lián)關系 | 修改集群與全局IP白名單模板的關聯(lián)關系。 |
SSL加密
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterSSL | 查詢PolarDB集群SSL設置 | 查詢PolarDB集群SSL設置。 |
| ModifyDBClusterSSL | 設置集群SSL | 開通、關閉PolarDB集群的SSL加密功能，或更新PolarDB集群的CA證書。 |
TDE加密
| API | 標題 | API概述 |
|---|---|---|
| CheckKMSAuthorized | 檢查kms密鑰是否已存在 | 查看用戶KMS開通狀態(tài)。 |
| DescribeDBClusterTDE | 查詢PolarDB集群的TDE設置詳情 | 查詢PolarDB引擎集群的TDE設置詳情。 |
| DescribeUserEncryptionKeyList | 查詢實例自定義密鑰列表 | 查看KMS密鑰列表。 |
| ModifyDBClusterTDE | 開啟PolarDB TDE功能 | ModifyDBClusterTDE |
節(jié)點管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDBNodes | 增加PolarDB集群的只讀節(jié)點 | 增加PolarDB集群的只讀節(jié)點。 |
| DeleteDBNodes | 刪除PolarDB集群的只讀節(jié)點 | 刪除PolarDB集群的只讀節(jié)點。 |
| ModifyDBNodeClass | 變更PolarDB集群節(jié)點規(guī)格 | 變更PolarDB集群節(jié)點規(guī)格。 |
| ModifyDBNodesClass | 變更PolarDB集群單個節(jié)點的規(guī)格 | 變更PolarDB集群單個節(jié)點的規(guī)格。 |
| ModifyDBNodeHotReplicaMode | 開啟或關閉集群熱備節(jié)點 | 開啟或關閉集群熱備節(jié)點。 |
| RestartDBNode | 重啟PolarDB集群節(jié)點 | 重啟PolarDB集群節(jié)點。 |
| TempModifyDBNode | 為集群臨時升配或增加節(jié)點 | 臨時變更配置。 |
| TempModifyDBNode | 為集群臨時升配或增加節(jié)點 | 臨時變更配置。 |
參數(shù)管理
| API | 標題 | API概述 |
|---|---|---|
| CreateParameterGroup | 創(chuàng)建參數(shù)模板 | 創(chuàng)建PolarDB參數(shù)模板。 |
| DescribeDBClusterParameters | 查看PolarDB集群當前參數(shù)運行列表 | 查看PolarDB集群當前參數(shù)運行列表。 |
| DescribeDBNodesParameters | 查詢集群中指定節(jié)點的參數(shù) | 查詢集群中指定節(jié)點的參數(shù)。 |
| DescribeParameterTemplates | 查詢參數(shù)模版列表 | 查詢數(shù)據(jù)庫集群默認參數(shù)的列表。 |
| DescribeParameterGroups | 查詢參數(shù)模板列表 | 查看目標地域的參數(shù)模板列表。 |
| DescribeParameterGroup | 查詢指定的參數(shù)模板信息 | 查詢目標參數(shù)模板詳情。 |
| DeleteParameterGroup | 刪除參數(shù)模板 | 刪除PolarDB參數(shù)模板。 |
| ModifyDBClusterAndNodesParameters | 修改集群參數(shù)并應用到指定節(jié)點 | 修改集群參數(shù)并應用到指定節(jié)點。 |
| ModifyDBClusterParameters | 修改PolarDB集群的參數(shù) | 修改PolarDB集群的參數(shù)或將已有的參數(shù)模板應用到目標集群上。 |
| ModifyDBNodesParameters | 修改單個節(jié)點的參數(shù)并應用到指定節(jié)點 | 修改單個節(jié)點的參數(shù)并應用到指定節(jié)點。 |
訪問地址管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDBClusterEndpoint | 創(chuàng)建自定義集群地址 | 創(chuàng)建PolarDB自定義集群地址。 |
| CreateDBEndpointAddress | 創(chuàng)建集群公網(wǎng)連接地址 | 創(chuàng)建PolarDB集群主地址、默認集群地址和自定義集群地址的公網(wǎng)連接地址。 |
| DescribeDBClusterEndpoints | 查詢PolarDB集群的地址信息 | 查詢PolarDB集群的地址信息。 |
| ModifyDBClusterEndpoint | 修改PolarDB的集群地址屬性 | 修改PolarDB的集群地址屬性，包括讀寫模式、新節(jié)點是否自動加入本地址、一致性級別、事務拆分、主庫是否接受讀、連接池等。 |
| ModifyDBEndpointAddress | 修改集群連接地址 | 修改PolarDB集群的連接地址，包括主地址、默認集群地址、自定義集群地址和私有域名。 |
| DeleteDBClusterEndpoint | 釋放PolarDB自定義集群地址 | 釋放PolarDB自定義集群地址。 |
| DeleteDBEndpointAddress | 釋放集群公網(wǎng)地址 | 釋放PolarDB集群的公網(wǎng)地址，包括主地址、默認集群地址和自定義的集群地址的公網(wǎng)連接地址。 |
日志管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeSlowLogRecords | 查看慢日志明細 | 查看PolarDB集群的慢日志明細。 |
| DescribeSlowLogs | 查詢PolarDB集群的慢日志統(tǒng)計信息 | 查詢PolarDB集群的慢日志統(tǒng)計信息。 |
| DescribeDBClusterAuditLogCollector | 查詢集群SQL采集功能 | 查詢PolarDB集群的SQL采集功能（例如審計日志、SQL洞察等）。 |
| ModifyDBClusterAuditLogCollector | 開啟或關閉集群的SQL采集功能 | 開啟或關閉PolarDB集群的SQL采集功能（例如審計日志、SQL洞察等）。 |
賬號管理
| API | 標題 | API概述 |
|---|---|---|
| CreateAccount | 創(chuàng)建PolarDB數(shù)據(jù)庫賬號 | 創(chuàng)建PolarDB數(shù)據(jù)庫賬號。 |
| CheckAccountName | 校驗賬號是否合法 | 校驗賬號名稱是否合法或當前集群中是否已存在重名的賬號。 |
| DescribeAccounts | 查詢數(shù)據(jù)庫賬號信息 | 查詢PolarDB集群的數(shù)據(jù)庫賬號信息。 |
| ModifyAccountDescription | 修改數(shù)據(jù)庫賬號的備注信息 | 修改PolarDB數(shù)據(jù)庫賬號的備注信息。 |
| GrantAccountPrivilege | 授權普通賬號訪問某個數(shù)據(jù)庫 | 授權普通賬號訪問PolarDB集群的某個數(shù)據(jù)庫。 |
| RevokeAccountPrivilege | 撤銷賬號對數(shù)據(jù)庫的訪問權限 | 移除PolarDB普通賬號對數(shù)據(jù)庫的訪問權限。 |
| ResetAccount | 重置高權限賬號權限 | 重置PolarDB高權限賬號。 |
| DeleteAccount | 刪除數(shù)據(jù)庫賬號 | 刪除PolarDB數(shù)據(jù)庫賬號。 |
| ModifyAccountPassword | 修改數(shù)據(jù)庫的賬號密碼 | 修改PolarDB數(shù)據(jù)庫的賬號密碼。 |
數(shù)據(jù)庫管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDatabase | 為PolarDB集群創(chuàng)建一個新的數(shù)據(jù)庫 | 為PolarDB集群創(chuàng)建一個新的數(shù)據(jù)庫。 |
| DeleteDatabase | 刪除PolarDB集群下的數(shù)據(jù)庫 | 刪除PolarDB集群下的數(shù)據(jù)庫。 |
| DescribeDatabases | 查詢PolarDB指定集群的數(shù)據(jù)庫詳情 | 查詢PolarDB指定集群的數(shù)據(jù)庫詳情。 |
| DescribeCharacterSetName | 查看數(shù)據(jù)庫支持的字符集列表 | 查看PolarDB MySQL版數(shù)據(jù)庫支持的字符集列表。 |
| CheckDBName | 校驗數(shù)據(jù)庫名稱是否合法 | 校驗數(shù)據(jù)庫名稱是否合法或當前集群中是否已存在重名的數(shù)據(jù)庫。 |
| DescribeDBInitializeVariable | 查詢數(shù)據(jù)庫屬性 | 查詢PolarDB數(shù)據(jù)庫支持的字符集、排序規(guī)則等屬性。 |
| ModifyDBDescription | 修改數(shù)據(jù)庫備注說明 | 修改PolarDB MySQL版數(shù)據(jù)庫的備注說明。 |
全球數(shù)據(jù)庫網(wǎng)絡（GDN）管理
| API | 標題 | API概述 |
|---|---|---|
| CreateGlobalDatabaseNetwork | 新建全球數(shù)據(jù)庫網(wǎng)絡 | 創(chuàng)建一個新的全球數(shù)據(jù)庫網(wǎng)絡（GDN）。 |
| DeleteGlobalDatabaseNetwork | 刪除全球數(shù)據(jù)庫網(wǎng)絡 | 刪除全球數(shù)據(jù)庫網(wǎng)絡（GDN）。 |
| DescribeGlobalDatabaseNetwork | 查詢全球數(shù)據(jù)庫網(wǎng)絡 | 查詢全球數(shù)據(jù)庫網(wǎng)絡（GDN）詳情。 |
| DescribeGlobalDatabaseNetworks | 查看所有全球數(shù)據(jù)庫網(wǎng)絡（GDN）詳情 | 查看賬號下所有全球數(shù)據(jù)庫網(wǎng)絡（GDN）的詳情。 |
| ModifyGlobalDatabaseNetwork | 修改全球數(shù)據(jù)庫網(wǎng)絡 | 修改全球數(shù)據(jù)庫網(wǎng)絡（GDN）。 |
| RemoveDBClusterFromGDN | 從全球數(shù)據(jù)庫網(wǎng)絡（GDN）中移除從集群 | 從全球數(shù)據(jù)庫網(wǎng)絡（GDN）中移除從集群。 |
| SwitchOverGlobalDatabaseNetwork | 切換全球數(shù)據(jù)庫網(wǎng)絡 | 切換全球數(shù)據(jù)庫網(wǎng)絡（GDN）中的主從集群。 |
| ResetGlobalDatabaseNetwork | 重建GDN中的從集群網(wǎng)絡 | 重建GDN中的從集群網(wǎng)絡。 |
備份管理
| API | 標題 | API概述 |
|---|---|---|
| CreateBackup | 為PolarDB集群創(chuàng)建全量快照備份 | 為PolarDB集群創(chuàng)建全量快照備份。 |
| DescribeBackups | 查看備份集列表 | 查詢PolarDB集群的備份信息。 |
| DescribeBackupTasks | 查詢備份任務列表 | 查詢集群的備份任務詳情。 |
| DescribeBackupLogs | 查詢備份日志列表 | 查詢備份日志列表、獲取備份日志下載地址。 |
| DescribeDetachedBackups | 查詢已被釋放集群中備份集詳情 | 查詢已被釋放的PolarDB集群中備份集詳情。 |
| DescribeDBClustersWithBackups | 查詢包含備份集的集群詳情 | 查詢某地域下包含備份集的PolarDB集群詳情。 |
| DeleteBackup | 刪除PolarDB集群的備份 | 刪除PolarDB集群的備份。 |
| 備份策略 | 備份策略 | |
| DescribeBackupPolicy | 查看PolarDB集群自動備份策略 | 查看PolarDB集群的自動備份策略。 |
| DescribeLogBackupPolicy | 查詢集群日志備份保留策略 | 查詢PolarDB集群日志備份的保留策略。 |
| ModifyBackupPolicy | 修改備份策略設置 | 修改PolarDB集群的自動備份策略。 |
| ModifyLogBackupPolicy | 修改集群日志備份保留策略 | 修改PolarDB集群的日志備份保留策略。 |
庫表恢復
| API | 標題 | API概述 |
|---|---|---|
| DescribeMetaList | 查看支持恢復的庫表信息詳情 | 查看支持恢復的庫表信息詳情。 |
| RestoreTable | 恢復PolarDB實例的某些數(shù)據(jù)庫或表到原實例 | 恢復PolarDB庫表。 |
從RDS遷移
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterMigration | 查詢PolarDB集群的遷移狀態(tài) | 查詢PolarDB集群的遷移狀態(tài)。 |
| ModifyDBClusterMigration | 切換或回滾遷移任務 | 切換或回滾RDS一鍵升級到PolarDB的遷移任務。 |
| CloseDBClusterMigration | 取消或完成遷移 | 取消或完成RDS一鍵升級到PolarDB的遷移任務。 |
標簽管理
| API | 標題 | API概述 |
|---|---|---|
| TagResources | 為PolarDB集群添加標簽 | 為PolarDB集群添加標簽。 |
| UntagResources | 將標簽從集群上解綁 | 將標簽從PolarDB集群上解綁。 |
| ListTagResources | 查詢一個或多個PolarDB集群已綁定的標簽列表 | 查詢一個或多個PolarDB集群已綁定的標簽列表，或者查詢一個或多個標簽綁定的PolarDB集群列表。 |
待處理事件管理
| API | 標題 | API概述 |
|---|---|---|
| DescribePendingMaintenanceAction | 查詢待處理事件的詳情 | 查詢待處理事件的詳情。 |
| DescribePendingMaintenanceActions | 查看不同任務類型下待處理事件的數(shù)量 | 查看不同任務類型下待處理事件的數(shù)量。 |
| ModifyPendingMaintenanceAction | 修改待處理事件的任務切換時間 | 修改待處理事件的任務切換時間。 |
計劃任務管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeScheduleTasks | 查詢定時任務詳情 | 查詢所有定時任務的詳情情況。 |
| CancelScheduleTasks | 取消定時任務 | 取消開始時間尚未到達的定時任務。 |
脫敏規(guī)則管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeMaskingRules | 查詢脫敏規(guī)則列表 | 查詢PolarDB集群下所有的脫敏規(guī)則或目標脫敏規(guī)則的詳情。 |
| ModifyMaskingRules | 修改脫敏規(guī)則 | 修改脫敏規(guī)則配置或新增脫敏規(guī)則。 |
| DeleteMaskingRules | 刪除脫敏規(guī)則 | 刪除目標脫敏規(guī)則。 |
監(jiān)控管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBNodePerformance | 查詢集群節(jié)點的性能數(shù)據(jù) | 查詢PolarDB集群節(jié)點的性能數(shù)據(jù)。 |
| DescribeDBClusterPerformance | 查詢PolarDB集群的性能數(shù)據(jù) | 查詢PolarDB集群的性能數(shù)據(jù)。 |
| DescribeDBProxyPerformance | 查詢PolarDB代理層（PolarProxy）的性能數(shù)據(jù) | 查詢PolarDB代理層（PolarProxy）的性能數(shù)據(jù)。 |
| DescribeDBClusterMonitor | 查詢集群監(jiān)控數(shù)據(jù)采集頻率 | 查詢PolarDB集群的監(jiān)控數(shù)據(jù)采集頻率。 |
| ModifyDBClusterMonitor | 修改集群監(jiān)控數(shù)據(jù)采集頻率 | 修改PolarDB集群的監(jiān)控數(shù)據(jù)采集頻率。 |
PolarDB for AI
| API | 標題 | API概述 |
|---|---|---|
| DescribeAITaskStatus | 獲取AI任務狀態(tài)數(shù)據(jù) | 查看PolarDB for AI功能狀態(tài)。 |
| OpenAITask | 開啟AI任務 | 開啟PolarDB for AI功能。 |
| CloseAITask | 關閉AI任務 | 關閉PolarDB for AI功能。 |
DBLink
| API | 標題 | API概述 |
|---|---|---|
| CreateDBLink | 創(chuàng)建DBLink | 創(chuàng)建DBLink。 |
| RestartDBLink | 重啟代理 | 重啟代理。 |
| DeleteDBLink | 刪除集群中DBLink | 刪除PolarDB PostgreSQL版（兼容Oracle）集群中的DBLink。 |
| DescribeDBLinks | 查詢集群DBLink信息 | 查詢PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。 |
連接診斷
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterConnectivity | 查詢源IP地址能否正常訪問數(shù)據(jù)庫 | 調用接口DescribeDBClusterConnectivity查詢源IP地址能否正常訪問數(shù)據(jù)庫。 |
冷數(shù)據(jù)歸檔
| API | 標題 | API概述 |
|---|---|---|
| CreateColdStorageInstance | 創(chuàng)建冷存儲實例 | 創(chuàng)建冷存儲實例。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| DescribeDasConfig | 查看集群 DAS 配置 | 查看集群對應的DAS配置。 |