API 概覽 - PolarDB

API標準及多語言預置SDK

本產品（polardb/2017-08-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

銷售管理

API	標題	API概述
CreateStoragePlan	建立儲存計劃	購買儲存包。
DescribeAutoRenewAttribute	查詢叢集自動續約狀態	查詢PolarDB訂用帳戶叢集自動續約狀態。
DescribeClassList	查詢polardb叢集的規格列表	查看叢集規格列表。
DescribeDBClusterAvailableResources	查詢PolarDB叢集可售賣資源	查詢PolarDB叢集可售賣資源。
EvaluateRegionResource	資源評估	進行資源評估。
ModifyAutoRenewAttribute	設定訂用帳戶叢集自動續約狀態	設定PolarDB訂用帳戶叢集自動續約狀態。
TransformDBClusterPayType	變更資料庫叢集付費類型	變更PolarDB叢集的計費方式。
DescribeZones	查詢可用性區域列表	查詢可用性區域
DescribeVSwitchList	查詢交換器列表	查詢交換器資訊
DescribeRdsVSwitchs	查詢交換器列表	查詢虛擬交換器列表
DescribeRdsVpcs	查詢VPC列表	查詢VPC資訊列表
DescribeVSwitches	查詢已建立的交換機	查詢交換機。
DescribeVpcs	查詢VPC列表	查詢vpc列表

叢集管理

API	標題	API概述
CreateDBCluster	建立叢集。	CreateDBCluster。
DeleteDBCluster	釋放隨用隨付的PolarDB叢集	釋放隨用隨付的PolarDB叢集。
DescribeDBClusters	查詢叢集列表。	查詢 PolarDB 叢集列表或被 RAM 授權的叢集列表詳情。
DescribeDBClusterAttribute	檢視 PolarDB 叢集的詳細屬性。	檢視叢集屬性資訊。
DescribeDBClusterServerlessConf	查詢Serverless叢集的配置	查詢serverless配置。
DescribePolarSQLCollectorPolicy	查詢叢集SQL洞察功能	查看目的地組群的SQL洞察功能是否已開啟。
DescribeDBClusterEncryptionKey	查詢PolarDB執行個體密鑰詳情	查詢指定PolarDB執行個體的密鑰使用詳情。
ModifyDBCluster	修改叢集功能配置。	修改 PolarDB MySQL 叢集的功能配置。
ModifyDBClusterDescription	修改叢集名稱	修改PolarDB叢集名稱。
ModifyDBClusterDeletion	開啟或者關閉叢集保護鎖	開啟或者關閉叢集保護鎖。
ModifyDBClusterMaintainTime	修改執行個體叢集可維護時間段	修改PolarDB叢集可例行維護的時間。
EnableDBClusterServerless	開啟穩態Serverless	開啟穩態Serverless。
DisableDBClusterServerless	關閉穩態 Serverless	關閉穩態 Serverless。
CreateCronJobPolicyServerless	建立Serverless配置定時任務	serverless建立周期任務策略
DescribeCronJobPolicyServerless	查看Serverless配置定時任務	查詢周期任務策略
ModifyCronJobPolicyServerless	修改Serverless配置定時任務	修改周期任務策略
ModifyDBClusterServerlessConf	修改Serverless叢集配置	修改Serverless叢集配置。
CancelCronJobPolicyServerless	取消Serverless定時任務	取消周期任務策略
ModifyDBClusterStorageSpace	變更企業版按空間計費叢集和標準版叢集的儲存空間	變更企業版按空間計費叢集和標準版叢集的儲存空間。
ManuallyStartDBCluster	手動啟動叢集	手動啟動叢集。
ModifyDBClusterStoragePerformance	變更儲存效能	PolarDB MySQL儲存效能變更配置。
RefreshDBClusterStorageUsage	更新叢集儲存使用量	更新叢集執行個體儲存使用量。
ModifyDBClusterResourceGroup	修改資料庫叢集資源群組	修改資料庫叢集資源群組。
DescribeDasConfig	查看叢集 DAS 配置	查看叢集對應的DAS配置。
ModifyDBClusterVpc	變更資料庫連接地址VPC	修改叢集VSwitch參數
EnableDBClusterDynamoDB	開啟叢集DynamoDB相容	開啟DynamoDB相容性能力
DisableDBClusterDynamoDB	關閉叢集DynamoDB相容	關閉DynamoDB相容性能力
EnableDBClusterOrca	開啟叢集Orca	開啟叢集的關係性
DisableDBClusterOrca	關閉叢集Orca	關閉叢集的關係性。

高可用部署架構

API	標題	API概述
ModifyDBClusterPrimaryZone	更換PolarDB叢集的可用性區域	更換PolarDB叢集的可用性區域。
FailoverDBCluster	對叢集進行手動主備切換	對PolarDB叢集進行手動主備切換，可以指定一個唯讀節點為新的主節點。
ModifyDBClusterArch	修改叢集的高可用模式	修改叢集的高可用模式。
DescribeDBLogFiles	查看執行個體HA切換記錄	查詢PolarDB叢集日誌資訊，如主備切換日誌。
DescribeHALogs	查詢執行個體高可用日誌	查詢執行個體高可用相關日誌。

核心版本管理

API	標題	API概述
DescribeDBMiniEngineVersions	查詢可用小版本	查詢可用核心小版本列表
DescribeDBClusterVersion	查看PolarDB MySQL叢集核心版本資訊	查看 PolarDB MySQL 叢集當前核心版本的詳細資料。
UpgradeDBClusterVersion	升級PolarDB MySQL版叢集的核心版本	升級PolarDB MySQL版叢集的核心版本。

白名單管理

API	標題	API概述
DescribeDBClusterAccessWhitelist	檢視叢集的 IP 白名單。	檢視允許存取資料庫叢集的 IP 白名單和安全性群組。
ModifyDBClusterAccessWhitelist	建立或修改叢集的白名單。	建立或修改叢集的白名單（包括 IP 白名單和安全性群組）。

全域 IP 白名單範本管理

API	標題	API概述
CreateGlobalSecurityIPGroup	建立全域白名單	建立全域IP白名單模板。
DeleteGlobalSecurityIPGroup	刪除全域白名單	刪除全域IP白名單模板。
DescribeGlobalSecurityIPGroup	查詢全域IP白名單模板列表	查詢全域IP白名單模板列表。
DescribeGlobalSecurityIPGroupRelation	查詢關聯關係	查詢叢集與全域IP白名單模板的關聯關係。
ModifyGlobalSecurityIPGroup	修改全域白名單	修改IP白名單模板。
ModifyGlobalSecurityIPGroupName	修改全域白名單名稱	修改全域IP白名單模板名稱。
ModifyGlobalSecurityIPGroupRelation	修改全域白名單關聯關係	修改叢集與全域IP白名單模板的關聯關係。

SSL 加密

API	標題	API概述
DescribeDBClusterSSL	查詢PolarDB叢集SSL設定。	查詢PolarDB叢集SSL設定。
ModifyDBClusterSSL	設定叢集 SSL。	開通或關閉 PolarDB 叢集的 SSL 加密功能，或更新 PolarDB 叢集的 CA 憑證。

TDE 加密

API	標題	API概述
CheckKMSAuthorized	檢查kms密鑰是否已存在	查看使用者KMS開通狀態。
DescribeDBClusterTDE	查詢PolarDB叢集的TDE設定詳情	查詢PolarDB引擎叢集的TDE設定詳情。
DescribeUserEncryptionKeyList	查詢執行個體自訂密鑰列表	查看KMS密鑰列表。
DescribeEncryptionDBSecret	查詢加密秘鑰狀態	擷取加密資訊
ModifyEncryptionDBSecret	修改加密秘鑰	變更加密策略
ModifyDBClusterTDE	開啟PolarDB TDE功能	ModifyDBClusterTDE

SQL 防火牆

API	標題	API概述
EnableFirewallRules	啟用實例的防火牆規則	修改sql防火牆狀態。
AddFirewallRules	添加防火牆規則	添加sql防火牆配置
DescribeFirewallRules	查詢防火牆規則	查詢sql防火牆資訊
ModifyFirewallRules	修改防火牆規則	修改sql防火牆配置
DeleteFirewallRules	刪除防火牆規則	刪除sql防火牆

SQL 限流

API	標題	API概述
EnableSQLRateLimitingRules	開啟執行個體的SQL限流規則	啟用/禁用SQL限流規則
AddSQLRateLimitingRules	添加SQL限流規則	添加SQL限流規則
DescribeSQLRateLimitingRules	查詢SQL限流規則	查詢SQL限流規則資訊
ModifySQLRateLimitingRules	修改SQL限流規則	修改SQL限流規則
DeleteSQLRateLimitingRules	刪除SQL限流規則	刪除SQL限流規則

節點管理

API	標題	API概述
CreateDBNodes	增加 PolarDB 叢集的唯讀節點	增加 PolarDB 叢集的唯讀節點。
DeleteDBNodes	刪除PolarDB叢集的唯讀節點	刪除PolarDB叢集的唯讀節點。
ModifyDBNodeDescription	修改PolarDB節點名稱	修改PolarDB節點名稱
ModifyDBNodeConfig	修改叢集節點配置	修改polardb叢集的配置資訊。
ModifyDBNodeSccMode	修改SCC功能	修改節點的Scc。
ModifyDBNodeClass	變更 PolarDB 叢集節點規格	變更 PolarDB 叢集節點規格。
ModifyDBNodesClass	變更PolarDB叢集單個節點的規格	變更PolarDB叢集單個節點的規格。
ModifyDBNodeHotReplicaMode	開啟或關閉叢集熱備節點	開啟或關閉叢集熱備節點。
RestartDBNode	重啟PolarDB叢集節點	重啟PolarDB叢集節點。
TempModifyDBNode	為叢集臨時升配或增加節點	臨時變更配置。

參數管理

API	標題	API概述
CreateParameterGroup	建立參數模板	建立PolarDB參數模板。
DescribeDBClusterParameters	查看PolarDB叢集當前參數運行列表	查看PolarDB叢集當前參數運行列表。
DescribeDBNodesParameters	查詢叢集中指定節點的參數	查詢叢集中指定節點的參數。
DescribeParameterTemplates	查詢參數模版列表	查詢資料庫叢集預設參數的列表。
DescribeParameterGroups	查詢參數模板列表	查看目標地區的參數模板列表。
DescribeParameterGroup	查詢指定的參數模板資訊	查詢目標參數模板詳情。
DescribeModifyParameterLog	查詢參數修改歷史	查詢參數修改歷史
DeleteParameterGroup	刪除參數模板	刪除PolarDB參數模板。
ModifyDBClusterAndNodesParameters	修改叢集參數並應用到指定節點	修改叢集參數並應用到指定節點。
ModifyDBClusterParameters	修改PolarDB叢集的參數	修改PolarDB叢集的參數或將已有的參數模板應用到目的地組群上。
ModifyDBNodesParameters	修改單個節點的參數並應用到指定節點	修改單個節點的參數並應用到指定節點。

存取位址管理

API	標題	API概述
CheckConnectionString	檢查串連地址是否存在	檢查串連串。
CreateDBClusterEndpoint	建立自訂叢集地址。	建立 PolarDB 自訂叢集地址。
CreateDBEndpointAddress	建立叢集公網串連地址	建立PolarDB叢集主地址、預設叢集地址和自訂叢集地址的公網串連地址。
DescribeDBClusterProxy	擷取叢集執行個體代理詳情	查詢代理詳情
DescribeDBClusterEndpoints	查詢PolarDB叢集的地址資訊	查詢PolarDB叢集的地址資訊。
DescribeDBClusterNetInfo	查詢資料庫連接地址	查詢資料庫連接地址資訊
ModifyDBClusterEndpoint	修改PolarDB的叢集地址屬性	修改PolarDB的叢集地址屬性，包括讀寫入模式、新節點是否自動加入本地址、一致性層級、事務拆分、主庫是否接受讀、串連池等。
ModifyDBEndpointAddress	修改叢集串連地址	修改PolarDB叢集的串連地址，包括主地址、預設叢集地址、自訂叢集地址和私人網域名稱。
DeleteDBClusterEndpoint	釋放PolarDB自訂叢集地址	釋放PolarDB自訂叢集地址。
DeleteDBEndpointAddress	釋放叢集公網地址	釋放PolarDB叢集的公網地址，包括主地址、預設叢集地址和自訂的叢集地址的公網串連地址。

日誌管理

API	標題	API概述
DescribeSlowLogRecords	查看慢日誌明細	查看PolarDB叢集的慢日誌明細。
DescribeSlowLogs	查詢PolarDB叢集的慢日誌統計資訊	查詢PolarDB叢集的慢日誌統計資訊。
DescribeDBClusterAuditLogCollector	查詢叢集SQL採集功能	查詢PolarDB叢集的SQL採集功能（例如審計日誌、SQL洞察等）。
ModifyDBClusterAuditLogCollector	開啟或關閉叢集的SQL採集功能	開啟或關閉PolarDB叢集的SQL採集功能（例如審計日誌、SQL洞察等）。

帳號管理

API	標題	API概述
CreateAccount	建立 PolarDB 資料庫帳號。	建立 PolarDB 資料庫帳號。
CheckAccountName	校正帳號是否合法	校正帳號名稱是否合法或當前叢集中是否已存在重名的帳號。
DescribeAccounts	查詢資料庫帳號資訊	查詢PolarDB叢集的資料庫帳號資訊。
ModifyAccountDescription	修改資料庫帳號的備忘資訊	修改PolarDB資料庫帳號的備忘資訊。
GrantAccountPrivilege	授權普通帳號訪問某個資料庫	授權普通帳號訪問PolarDB叢集的某個資料庫。
RevokeAccountPrivilege	撤銷帳號對資料庫的存取權限	移除PolarDB普通帳號對資料庫的存取權限。
ModifyAccountLockState	修改PolarDB資料庫帳號的鎖定狀態。	修改PolarDB資料庫帳號的鎖定狀態。
ResetAccount	重設高許可權帳號許可權	重設PolarDB高許可權帳號。
DeleteAccount	刪除資料庫帳號	刪除PolarDB資料庫帳號。
ModifyAccountPassword	修改資料庫的帳號密碼	修改PolarDB資料庫的帳號密碼。
ResetAccountPassword	重設PolarDB資料庫帳號密碼。	重設PolarDB資料庫帳號密碼。

資料庫管理

API	標題	API概述
CreateDatabase	為PolarDB叢集建立一個新的資料庫	為PolarDB叢集建立一個新的資料庫。
DeleteDatabase	刪除PolarDB叢集下的資料庫	刪除PolarDB叢集下的資料庫。
DescribeDatabases	查詢PolarDB指定叢集的資料庫詳情	查詢PolarDB指定叢集的資料庫詳情。
DescribeCharacterSetName	查看資料庫支援的字元集列表	查看PolarDB MySQL版資料庫支援的字元集列表。
CheckDBName	校正資料庫名稱是否合法	校正資料庫名稱是否合法或當前叢集中是否已存在重名的資料庫。
DescribeDBInitializeVariable	查詢資料庫屬性	查詢PolarDB資料庫支援的字元集、定序等屬性。
ModifyDBDescription	修改資料庫備忘說明	修改PolarDB MySQL版資料庫的備忘說明。

全球資料庫網路（GDN）

API	標題	API概述
CreateGlobalDatabaseNetwork	建立全球資料庫網路	建立一個新的全球資料庫網路（GDN）。
DeleteGlobalDatabaseNetwork	刪除全球資料庫網路	刪除全球資料庫網路（GDN）。
DescribeGlobalDatabaseNetwork	查詢全球資料庫網路	查詢全球資料庫網路（GDN）詳情。
DescribeGlobalDatabaseNetworks	查看所有全球資料庫網路（GDN）詳情	查看帳號下所有全球資料庫網路（GDN）的詳情。
ModifyGlobalDatabaseNetwork	修改全球資料庫網路	修改全球資料庫網路（GDN）。
RemoveDBClusterFromGDN	從全球資料庫網路（GDN）中移除從叢集	從全球資料庫網路（GDN）中移除從叢集。
SwitchOverGlobalDatabaseNetwork	切換全球資料庫網路	切換全球資料庫網路（GDN）中的主從叢集。
ResetGlobalDatabaseNetwork	重建GDN中的從叢集網路	重建GDN中的從叢集網路。

備份管理

API	標題	API概述
CreateBackup	為 PolarDB 叢集建立全量快照備份。	為 PolarDB 叢集建立全量快照備份。
DescribeBackups	檢視備份集清單。	查詢 PolarDB 叢集的備份資訊。
DescribeBackupTasks	查詢備份工作清單	查詢叢集的備份任務詳情。
DescribeBackupLogs	查詢備份日誌列表	查詢備份日誌列表、擷取備份日誌下載地址。
DescribeDetachedBackups	查詢已被釋放叢集中備份組詳情	查詢已被釋放的PolarDB叢集中備份組詳情。
DescribeDBClustersWithBackups	查詢包含備份組的叢集詳情	查詢某地區下包含備份組的PolarDB叢集詳情。
DescribeBackupRegions	查詢備份組地區列表	查詢備份組所在地區資訊。
DescribeAvailableCrossRegions	查詢跨地區備份可用地區列表	查詢跨地區備份可用地區列表。
DescribeLocalAvailableRecoveryTime	查詢備份可恢復範圍	查詢備份可恢復範圍。
DeleteBackup	刪除PolarDB叢集的備份	刪除PolarDB叢集的備份。
ReactivateDBClusterBackup	重新開啟PolarDB執行個體備份功能	重新開啟備份功能。
備份策略	備份策略
DescribeBackupPolicy	查看PolarDB叢集自動備份策略	查看PolarDB叢集的自動備份策略。
DescribeLogBackupPolicy	查詢叢集記錄備份保留原則	查詢PolarDB叢集記錄備份的保留原則。
ModifyBackupPolicy	修改備份原則設定	修改PolarDB叢集的自動備份策略。
ModifyLogBackupPolicy	修改叢集記錄備份保留原則	修改PolarDB叢集的記錄備份保留原則。

資料庫與資料表還原

API	標題	API概述
DescribeMetaList	查看支援恢複的庫表資訊詳情	查看支援恢複的庫表資訊詳情。
RestoreTable	恢複PolarDB執行個體的某些資料庫或表到原執行個體	恢複PolarDB庫表。

從 RDS 遷移

API	標題	API概述
DescribeDBClusterMigration	查詢PolarDB叢集的遷移狀態	查詢PolarDB叢集的遷移狀態。
ModifyDBClusterMigration	切換或復原遷移任務	切換或復原RDS一鍵升級到PolarDB的遷移任務。
ContinueDBClusterMigration	繼續升級/遷移任務	繼續當前升級/遷移任務
ModifyDBClusterMigrationEndpoint	修改DTS任務指向	修改dts源執行個體、目標執行個體
CloseDBClusterMigration	取消或完成遷移	取消或完成RDS一鍵升級到PolarDB的遷移任務。
AbortDBClusterMigration	退出升級/遷移	退出升級或遷移

標籤管理

API	標題	API概述
ListTagResourcesForRegion	ListTagResourcesForRegion	查詢region下資源tag。

待處理事件管理

API	標題	API概述
DescribeHistoryEvents	查詢事件中心的事件列表	事件中心事件列表
ModifyActiveOperationMaintainConf	修改主動營運事件	配置使用者的營運資訊，目前包括主動營運視窗資訊
DescribeActiveOperationMaintainConf	查看主動營運事件	擷取使用者的營運配置資訊，目前包括主動營運視窗資訊
DescribePendingMaintenanceAction	查詢待處理事件的詳情	查詢待處理事件的詳情。
DescribePendingMaintenanceActions	查看不同任務類型下待處理事件的數量	查看不同任務類型下待處理事件的數量。
ModifyPendingMaintenanceAction	修改待處理事件的任務切換時間	修改待處理事件的任務切換時間。
ModifyActiveOperationTasks	修改營運事件的計劃切換時間	修改執行個體計劃內營運事件的切換時間。
DescribeActiveOperationTasks	查詢多個主動營運任務資訊	查詢執行個體的營運事件詳情。
CancelActiveOperationTasks	取消營運事件	批量取消營運事件。

排程任務管理

API	標題	API概述
DescribeHistoryTasks	查詢歷史任務	PolarDB MySQL 查詢歷史工作清單。
DescribeScheduleTasks	查詢定時任務詳情	查詢所有定時任務的詳情情況。
ModifyScheduleTask	修改定時任務	修改目標計劃任務。
CancelScheduleTasks	取消定時任務	取消開始時間尚未到達的定時任務。

去識別化規則管理

API	標題	API概述
DescribeMaskingRules	查詢脫敏規則列表	查詢PolarDB叢集下所有的脫敏規則或目標脫敏規則的詳情。
ModifyMaskingRules	修改脫敏規則	修改脫敏規則配置或新增脫敏規則。
DeleteMaskingRules	刪除脫敏規則	刪除目標脫敏規則。

監控管理

API	標題	API概述
DescribeDBNodePerformance	查詢叢集節點的效能資料	查詢PolarDB叢集節點的效能資料。
DescribeDBClusterPerformance	查詢PolarDB叢集的效能資料	查詢PolarDB叢集的效能資料。
DescribeDBProxyPerformance	查詢PolarDB代理層（PolarProxy）的效能資料	查詢PolarDB代理層（PolarProxy）的效能資料。
DescribeDBInstancePerformance	查詢計算節點效能監控	擷取計算節點效能監控
DescribeDBClusterMonitor	查詢叢集監控資料擷取頻率	查詢PolarDB叢集的監控資料擷取頻率。
ModifyDBClusterMonitor	修改叢集監控資料擷取頻率	修改PolarDB叢集的監控資料擷取頻率。
DescribeAIDBClusterPerformance	擷取ai容器效能指標	擷取ai容器效能指標。

PolarDB for AI

API	標題	API概述
DescribeAITaskStatus	擷取AI任務狀態資料	查看PolarDB for AI功能狀態。
OpenAITask	開啟AI任務	開啟PolarDB for AI功能。
CloseAITask	關閉AI任務	關閉PolarDB for AI功能。

網路通道

API	標題	API概述
CreateNetworkChannel	建立網路通道	建立網路通道
DescribeNetworkChannel	查詢網路通道	查詢網路通道
DeleteNetworkChannel	刪除網路通道	刪除網路通道

DBLink

API	標題	API概述
CreateDBLink	建立DBLink	建立DBLink。
RestartDBLink	重啟代理	重啟代理。
DeleteDBLink	刪除叢集中DBLink	刪除PolarDB PostgreSQL版（相容Oracle）叢集中的DBLink。
DescribeDBLinks	查詢叢集DBLink資訊	查詢PolarDB PostgreSQL版（相容Oracle）叢集的DBLink資訊。

連線診斷

API	標題	API概述
DescribeDBClusterConnectivity	查詢源IP地址能否正常訪問資料庫	查詢源IP地址能否正常訪問資料庫。

外掛程式

API	標題	API概述
CreateExtensions	安裝外掛程式	建立外掛程式
DescribeExtensions	查詢安裝外掛程式	查詢外掛程式詳情
UpdateExtensions	更新外掛程式	更新外掛程式
DeleteExtensions	卸載外掛程式	刪除外掛程式

冷資料封存

API	標題	API概述
CreateColdStorageInstance	建立冷儲存執行個體	建立冷儲存執行個體。
DescribeColdStorageInstance	描述冷儲存執行個體	查詢冷儲存執行個體資訊。

PolarDB 應用程式

API	標題	API概述
DescribeApplications	查詢PolarDB應用列表	擷取指定地區內所有PolarDB執行個體的應用列表。
CreateApplication	建立PolarDB應用	用於建立一個附屬於PolarDB執行個體的應用。
DescribeApplicationAttribute	查詢PolarDB應用屬性	擷取指定PolarDB執行個體應用的詳細資料。
DescribeApplicationParameters	擷取PolarDB應用組件參數	擷取指定應用及其組件的當前參數和模板資訊。
DescribeApplicationServerlessConf	查詢PolarDB應用Serverless配置	查詢PolarDB應用Serverless配置
ModifyApplicationServerlessConf	修改PolarDB應用Serverless配置	修改PolarDB應用Serverless配置
ModifyApplicationParameter	修改PolarDB應用子組件參數	用於修改PolarDB應用中指定子組件的配置參數。
ModifyApplicationDescription	修改PolarDB應用備忘	用於更新PolarDB應用的描述資訊。
ModifyApplicationWhitelist	修改PolarDB應用白名單	用於修改PolarDB應用的IP白名單和安全性群組配置。
CreateApplicationEndpointAddress	建立PolarDB應用串連地址	為指定的應用建立一個新的串連地址。
DeleteApplicationEndpointAddress	刪除PolarDB應用串連地址	用於刪除指定PolarDB應用的特定串連地址。
ApplyApplicationPrompts	應用提示詞策略	應用提示詞策略到執行個體。
CreateApplicationPrompt	建立應用提示詞	建立應用提示詞策略
DescribeApplicationPrompts	查詢應用提示詞列表	查詢當前應用下所有的應用提示詞策略列表
ModifyApplicationPrompt	修改應用提示詞	修改應用提示詞策略
DeleteApplicationPrompt	刪除應用提示詞	刪除應用提示詞策略
AttachApplicationPolarFS	掛載Polarlakebase執行個體到PolarDB應用	將指定的Polarlakebase執行個體掛載到PolarDB應用。
DeleteApplication	刪除PolarDB應用	刪除指定的PolarDB應用，不會刪除PolarDB執行個體本身。
UpdateApplicationEnvironmentVariables	更新應用環境變數	更新應用環境變數 \- 目前僅支援PolarClaw
RemoveApplicationEnvironmentVariables	刪除應用環境變數	刪除應用環境變數 \- 目前僅支援PolarClaw
DescribeApplicationLogs	AI 應用程式日誌。	AI 應用程式日誌明細。
PolarClaw	PolarClaw
GetPolarClawConfig	擷取PolarClaw配置	擷取PolarClaw配置
PatchPolarClawConfig	更新PolarClaw配置	更新PolarClaw配置
DescribePolarClawAgents	列出PolarClaw Agent。	查詢指定應用下所有已安裝的外掛程式及其狀態資訊。
CreatePolarClawAgent	建立PolarClaw Agent	用於建立一個新的PolarClaw Agent
UpdatePolarClawAgent	更新PolarClaw Agent。	更新PolarClaw Agent。
UpgradePolarClawSkills	升級PolarClaw技能	升級PolarClaw技能
DeletePolarClawAgent	刪除PolarClaw Agent	此API用於從指定PolarClaw中移除一個Agent及其相關綁定。
ListPolarClawBindings	列出所有PolarClaw綁定	列出PolarClaw綁定關係
UnbindPolarClawAgent	解除綁定PolarClaw Agent	解除綁定PolarClaw Agent
BindPolarClawAgent	綁定PolarClaw Agent	將指定的Channel與特定的PolarClaw Agent進行綁定。
DescribePolarClawPlugins	列出所有PolarClaw外掛程式	列出所有已安裝的PolarClaw外掛程式及其狀態資訊。
InstallPolarClawPlugin	安裝PolarClaw外掛程式	安裝PolarClaw外掛程式
EnablePolarClawPlugin	啟用PolarClaw外掛程式	啟用PolarClaw外掛程式
DisablePolarClawPlugin	禁用PolarClaw外掛程式	禁用PolarClaw外掛程式
UpgradePolarClawPlugin	升級PolarClaw外掛程式	升級PolarClaw外掛程式
UninstallPolarClawPlugin	卸載PolarClaw外掛程式	卸載PolarClaw外掛程式
DescribePolarClawChannels	列出PolarClaw通道	列出所有已安裝的PolarClaw通道及其狀態資訊。
CreatePolarClawChannel	建立PolarClaw通道	用於在PolarClaw中建立新的通訊通道。
EnablePolarClawChannel	啟用PolarClaw通道	啟用PolarClaw通道
DisablePolarClawChannel	禁用PolarClaw通道	此API用于禁用指定的PolarClaw中的PolarClaw通道。
UpgradePolarClawChannel	升級PolarClaw通道	升級PolarClaw通道
DeletePolarClawChannel	刪除 PolarClaw 通道	刪除 PolarClaw 通道
DescribePolarClawCronJobs	列出所有PolarClaw定時任務	查詢PolarClaw中所有或指定的定時任務及其詳細資料。
CreatePolarClawCronJob	建立定時任務	用於建立一個PolarClaw定時任務。
UpdatePolarClawCronJob	更新PolarClaw定時任務配置	更新已有PolarClaw定時任務的配置，支援部分欄位更新。
EnablePolarClawCronJob	啟用PolarClaw定時任務	用於啟用PolarClaw中的定時任務功能。
DisablePolarClawCronJob	禁用PolarClaw定時任務	禁用PolarClaw定時任務
RunPolarClawCronJob	執行PolarClaw定時任務	執行PolarClaw定時任務
DeletePolarClawCronJob	刪除PolarClaw定時任務	用於刪除指定PolarClaw的定時任務。
DescribePolarClawMCPServers	列出所有PolarClaw MCP 服務	列出所有已安裝的PolarClaw MCP 服務和配置。
AddPolarClawMCPServer	添加PolarClaw MCP伺服器	此API用於向指定PolarClaw應用中添加MCP伺服器。
RemovePolarClawMCPServer	刪除PolarClaw MCP 服務	刪除PolarClaw MCP 服務
PolarClaw	PolarClaw

AI 閘道器

API	標題	API概述
CreateGateway	建立網關執行個體	建立網關執行個體。
DescribeGatewayList	查詢網關執行個體列表	查詢網關執行個體列表
DescribeGatewayAttribute	查詢網關執行個體詳情	查詢網關執行個體詳情
DeleteGateway	刪除網關執行個體	刪除網關執行個體。
CreateBudgetPolicy	建立預算策略	建立預算策略
DescribeBudgetPolicies	查詢預算策略。	查詢預算策略。
ModifyBudgetPolicy	修改預算策略	修改預算策略
DeleteBudgetPolicy	刪除預算策略	刪除預算策略
CreateRateLimitPolicy	建立限流策略	建立限流策略
DescribeRateLimitPolicy	查詢限流策略	查詢限流策略。
ModifyRateLimitPolicy	修改限流策略	修改限流策略。
DeleteRateLimitPolicy	刪除限流策略	刪除限流策略。
CreateModelService	建立模型服務	建立模型服務
DescribeModelServices	查詢模型服務列表	查詢模型服務列表
ModifyModelService	修改模型服務	修改模型服務
DeleteModelService	刪除模型服務	刪除模型服務
CreateModelApi	建立模型 API	建立路由規則
DescribeModelApis	查詢模型 API	查詢模型 API
ModifyModelApi	修改模型API	修改模型API
DeleteModelApi	刪除模型 API	刪除模型 API。
CreateCostRule	建立成本規則	建立成本規則
DescribeCostRules	查詢成本規則	查詢成本規則。
ModifyCostRule	修改成本規則	修改成本規則
DeleteCostRule	刪除成本規則	刪除成本規則
CreateConsumerGroup	建立消費者組	建立消費者組
DescribeConsumerGroups	查詢消費者組列表	查詢消費者組列表
ModifyConsumerGroup	修改消費者組	修改消費者組
DeleteConsumerGroup	刪除消費者組	刪除消費者組
CreateConsumer	建立消費者	建立消費者。
DescribeConsumers	查詢消費者列表。	查詢消費者列表。
ModifyConsumer	修改消費者	修改消費者
DeleteConsumer	刪除消費者	刪除消費者
ResetConsumerApiKey	重設API密鑰	重設API密鑰

Polarlakebase 執行個體

API	標題	API概述
AddPolarFsQuota	新增Polarlakebase配額規則	為Polarlakebase執行個體添加新的目錄配額規則。
DescribePolarFsAttribute	查詢 Polarlakebase 叢集詳細資訊。	取得 Polarlakebase 執行個體詳細資訊。
DescribePolarFsQuota	查詢Polarlakebase配額規則	擷取指定Polarlakebase執行個體下的全部配額規則資訊。
SetPolarFsFileQuota	為目錄應用配額規則	設定Polarlakebase執行個體中指定目錄的檔案配額規則。
CheckPolarFsQuotaConsistency	檢查配額一致性	用於檢查PolarFS執行個體中配額設定的一致性狀態。
CancelPolarFsFileQuota	刪除Polarlakebase檔案配額	用於刪除指定Polarlakebase執行個體下的一個或多個檔案路徑的配額規則。
DeletePolarFsQuota	刪除Polarlakebase Quota規則	用於刪除指定Polarlakebase執行個體下的一個或多個Quota規則。
DescribeGlobalDataNetworkList	查詢所有地區的 Polarlakebase 全球資料網路（GDN）詳情	查詢所有地區的 Polarlakebase 全球資料網路（GDN）詳情。
CreateGlobalDataNetwork	建立一個新的 Polarlakebase 全球資料網路（GDN）	建立一個新的 Polarlakebase 全球資料網路（GDN）。
DeleteGlobalDataNetwork	刪除 Polarlakebase 全球資料網路（GDN）	刪除 Polarlakebase 全球資料網路（GDN）。
ClonePolarFsBasicSnapshot	複製檔案	支援基礎版支援clone檔案或目錄快照
DescribePolarFsObjects	查詢目錄項	列出指定路徑下的檔案和子目錄資訊。
CreatePolarFsObject	建立目錄介面	用於在指定PolarFS執行個體中建立新的目錄。
MovePolarFsObjects	移動/重新命名目錄介面	重新命名或移動檔案
DeletePolarFsObjects	刪除檔案	刪除PolarLakebase檔案，當前僅支援基礎版和冷存版。
AddPolarFsPathMapping	添加Polarfs透明加速形態下配置bucket路徑映射	新增透明加速路徑
DeletePolarFsPathMapping	刪除Polarfs透明加速形態下配置bucket路徑映射	刪除透明加速路徑映射

AI 叢集

API	標題	API概述
DescribeAvailableModels	取得 AI 叢集模型清單。	取得 AI 叢集模型清單。
CreateAIDBClusterTask	建立模型運算子執行個體。	建立模型運算子執行個體。
DescribeAIDBClusterTasks	查詢模型運算子清單。	用於取得指定 PolarDB 資料庫執行個體下的模型運算子清單。
DescribeAIDBClusters	查詢AI叢集列表	查看custom叢集列表
DescribeAIDBClusterTaskAttribute	查詢任務詳細資訊。	取得任務執行個體詳細資訊。
CreateAIDBClusterDataset	建立資料集	建立資料集
DescribeAIDBClusterDatasets	查詢資料集列表	查詢資料集列表
ModifyAIDBClusterDescription	修改AI叢集名稱	修改AI執行個體名稱
DescribeAIDBClusterAttribute	查詢 AI 叢集的詳細屬性。	檢視 custom 執行個體詳細資訊。
DeleteAINodes	刪除ai叢集子節點	刪除ai執行個體子節點
CreateAINodes	添加AI叢集子節點	建立AI節點。
DescribeAIDBClusterTaskLogFiles	查詢模型運算元日誌	查詢模型運算元日誌
DescribeAIDBClusterTaskMetrics	查詢模型運算元指標	查詢模型運算元指標
DeleteAIDBCluster	刪除AI叢集執行個體	刪除AI叢集執行個體
DeleteAIDBClusterDataset	刪除資料集	刪除資料集
DeleteAIDBClusterTask	刪除任務	刪除任務執行個體

服務連結角色

API	標題	API概述
CreateServiceLinkedRole	建立服務關聯角色	調用 CreateServiceLinkedRole 介面建立服務關聯角色。
CheckServiceLinkedRole	查看是否已建立服務關聯角色	調用 CheckServiceLinkedRole 介面查看是否已建立服務關聯角色。
AddEncryptionDBRolePrivilege	添加角色權限原則	添加角色許可權
ModifyEncryptionDBRolePrivilege	修改角色權限原則	變更角色許可權
DeleteEncryptionDBRolePrivilege	刪除角色權限原則	刪除角色
DescribeEncryptionDBRolePrivilege	擷取角色許可權名稱列表	擷取角色許可權列表

邊緣叢集

API	標題	API概述
UpgradeDBClusterVersionZonal	升級邊緣叢集核心版本	PolarDB 邊緣雲叢集小版本升級
CreateAccountZonal	建立邊緣叢集帳號	建立邊緣雲帳號
RestartDBNodeZonal	重啟邊緣叢集節點	重啟poalrdb邊緣雲叢集節點
DescribeAccountsZonal	查詢邊緣叢集帳號資訊	查詢PolarDB邊緣雲叢集列表
DeleteDBClusterEndpointZonal	刪除邊緣叢集自訂叢集地址	刪除PolarDB 邊緣雲叢集的連結地址
CreateDatabaseZonal	建立邊緣叢集資料庫	建立PolarDB邊緣雲資料庫
GrantAccountPrivilegeZonal	授權邊緣叢集普通帳號訪問資料庫	修改PolarDB邊緣叢集的帳號許可權
ModifyDBDescriptionZonal	修改邊緣叢集資料庫備忘	修改PolarDB邊緣雲叢集資料庫描述
CheckDBNameZonal	校正邊緣叢集資料庫名稱是否合法	檢查PolarDB邊緣雲資料庫名
DescribeDBClusterVersionZonal	查詢邊緣叢集核心版本資訊	PolarDB邊緣叢集查詢版本
ModifyDBClusterEndpointZonal	修改邊緣叢集叢集地址屬性	PolarDB邊緣叢集修改連結地址
ModifyAccountPasswordZonal	修改邊緣叢集帳號密碼	修改PolarDB邊緣的帳號密碼
DeleteAccountZonal	刪除邊緣叢集帳號	刪除PolarDB邊緣雲叢集帳號
ModifyAccountDescriptionZonal	修改邊緣叢集帳號備忘資訊	修改PolarDB邊緣雲帳號的描述
ResetAccountZonal	重設邊緣叢集高許可權帳號許可權	重設PolarDB邊緣叢集帳號
CreateDBClusterEndpointZonal	建立邊緣叢集自訂叢集地址	邊緣雲建立連結地址介面
RevokeAccountPrivilegeZonal	撤銷邊緣叢集帳號對資料庫的存取權限	撤銷帳號許可權
ModifyDBClusterDescriptionZonal	修改邊緣叢集名稱	修改叢集描述
DescribeDatabasesZonal	查詢邊緣叢集資料庫資訊	查詢PolarDB邊緣雲資料庫
DescribeDBClusterEndpointsZonal	查詢邊緣叢集地址資訊	查詢PolarDB邊緣叢集的連結地址
DeleteDatabaseZonal	刪除邊緣叢集資料庫	刪除PolarDB邊緣雲叢集資料庫
FailoverDBClusterZonal	對邊緣叢集進行手動主備切換	角色切換
DescribeDbClusterAttributeZonal	查詢邊緣叢集詳情	查詢邊緣叢集詳情。
CheckAccountNameZonal	校正邊緣叢集帳號名稱是否合法	檢查PolarDB帳號名稱
DescribeDBClustersZonal	查詢邊緣叢集列表	MyBase中的PolarDB列表

其他

API	標題	API概述
DescribeActivationCodes	擷取啟用碼列表	查詢啟用碼列表。
DescribeLicenseOrderDetails	擷取認證訂單詳情	查看License訂單詳情。
DescribeLicenseOrders	擷取認證訂單列表	查詢License訂單列表。
CreateOrGetVirtualLicenseOrder	建立或擷取虛擬認證訂單	建立或擷取虛擬認證訂單。
CreateActivationCode	產生輕量化版本啟用碼	產生輕量化版本啟用碼。
DescribeActivationCodeDetails	擷取啟用碼詳情	查詢啟用碼詳情。
DescribeCrossCloudLevels	查詢跨雲支援的規格列表	查詢跨雲支援的規格列表。
DescribeCrossCloudRegion	查詢跨雲開區資訊	查詢跨雲開區資訊。
DescribeCrossCloudRegionMappingToAliyun	查詢跨雲地區映射	查詢跨雲地區映射。
DescribeHistoryTasksStat	歷史任務統計記錄	工作中樞任務統計
DescribeResourcePackages	查詢跨雲資源套件列表	查詢跨雲資源套件列表。
DescribeUpgradeReport	查詢升級/遷移校正報告	查詢校正報告
ExecuteCrossCloudOpenAPI	調用跨雲 OpenAPI	調用跨雲 OpenAPI。
GenerateUpgradeReportForSyncClone	產生升級/遷移校正報告	產生校正報告
ListOrders	查詢訂單列表	查詢訂單
ModifyResourcePackage	配置跨雲資源套件	配置跨雲資源套件。
DescribePolarAgentChatRecords	查詢指定會話明細	查詢指定會話明細
DescribePolarAgentSessionStatus	查詢工作階段狀態	查詢工作階段狀態
DescribePolarAgentUserSessions	查看歷史會話記錄	查看歷史會話記錄
GetPolarAgent	建立聊天記錄	建立聊天記錄

Others

API	標題	API概述
ApprovePolarClawDevicePair	批准PolarClaw裝置配對	批准PolarClaw裝置配對
CreateAIDBCluster	建立AI叢集	建立AI叢集。
CreateBatchConsumer	批次建立閘道使用者ApiKey	批次建立apikey。
CreateBatchTask	建立批量任務	建立批量任務。
DescribeAgenticDBClusters	查詢Agentic叢集列表。	查詢Agentic Database叢集列表。
DescribeApikeyAttribute	查詢該 apikey 的詳細資訊。	查詢該 apikey 的詳細資訊。
DescribeApplicationPerformance	查詢PolarDB AI應用效能	查詢PolarDB AI應用效能。
DescribeApplicationSessionIds	查詢 AI 應用程式對話。	AI 應用程式對話。
DescribeBatchTask	查詢批量任務狀態詳情	查詢批量任務狀態詳情。
DescribeBatchTasks	查詢批量任務狀態	查詢批量任務狀態。
DescribeDBClusterPrice	查詢 DB 執行個體價格。	查詢叢集價格。
DescribeGatewayApikeyList	查詢該UID下所有的ApiKeys	查詢該UID下所有的apikeys。
DescribePolarClawAgentFile	查詢 PolarClaw Agent 檔案。	查詢 PolarClaw Agent 檔案。
DescribePolarClawAgentTools	查詢PolarClaw Agent工具目錄。	查詢PolarClaw Agent工具目錄。
DescribePolarClawSkillDetail	查詢PolarClaw Skill詳情。	查詢PolarClaw Skill詳情。
DescribePolarClawTask	查詢PolarClaw非同步任務狀態	查詢PolarClaw非同步任務狀態
DescribePolarFs	查詢PolarFs叢集列表。	查看polarfs資訊。
DescribePolarFsQuotaList	查詢所有配額	查詢配額列表。
DescribeRegions	查看使用者可選的地區和可用性區域	查詢PolarDB支援的地區和可用性區域。
DescribeSharedBackups	查詢共用備份組列表	查詢共用備份組列表。
DescribeTasks	擷取工作清單	查看通過API產生的任務（如建立叢集）進度詳情。
InstallPolarClawSkill	安裝PolarClaw Skill。	安裝PolarClaw Skill。
ListPolarClawDevicePairs	列出PolarClaw裝置配對	列出PolarClaw裝置配對
ListTagResources	查詢一個或多個PolarDB叢集已綁定的標籤列表	查詢一個或多個PolarDB叢集已綁定的標籤列表，或者查詢一個或多個標籤綁定的PolarDB叢集列表。
LoginPolarClawChannel	登入PolarClaw通道	登入PolarClaw通道
OperateApplication	操作 PolarDB AI 應用	重新啟動、暫停、啟動一個 PolarDB 執行個體的應用，不刪除執行個體。
RejectPolarClawDevicePair	拒絕PolarClaw裝置配對	拒絕PolarClaw裝置配對
RemovePolarClawDevicePair	移除PolarClaw已配對裝置	移除PolarClaw已配對裝置
SearchMemories	搜尋記憶應用記憶	檢索記憶
SearchPolarClawSkills	搜尋 PolarClaw Skills。	搜尋 PolarClaw Skills。
TagResources	為PolarDB叢集添加標籤	為PolarDB叢集添加標籤。
UntagResources	將標籤從叢集上解除綁定	將標籤從PolarDB叢集上解除綁定。
UpdatePolarClawAgentSkills	更新 PolarClaw Agent 的 Skill。	更新 PolarClaw Agent 的 Skill。
UpdatePolarClawAgentTools	更新PolarClaw Agent工具配置。	更新PolarClaw Agent工具配置。
UpdatePolarClawSkill	更新PolarClaw Skill配置。	更新PolarClaw Skill配置。