API 概覽 - PolarDB

API標準及多語言預置SDK

本產品（polardbx/2020-02-02）的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概述
CreateDBInstance	建立執行個體	調用CreateDBInstance介面建立PolarDB-X執行個體。
DeleteDBInstance	刪除執行個體	呼叫DeleteDBInstance介面刪除執行個體。
DescribeDBInstanceAttribute	查詢執行個體屬性	呼叫 DescribeDBInstanceAttribute 介面取得執行個體屬性。
DescribeDBInstanceConfig	查詢執行個體設定參數。	呼叫 DescribeDBInstanceConfig 介面取得執行個體設定參數。
DescribeDBInstances	查詢資料庫執行個體清單。	呼叫 DescribeDBInstances 介面查詢執行個體清單。
DescribeDBInstanceSSL	檢視 SSL 資訊。	檢視 SSL 資訊。
DescribeDBInstanceTDE	取得執行個體 TDE 的詳細資訊。	呼叫 DescribeDBInstanceTDE 介面以取得執行個體 TDE 的詳細資訊。
DescribeDBInstanceTopology	查詢執行個體拓撲資訊。	呼叫 DescribeDBInstanceTopology 介面取得執行個體拓撲資訊。
DescribeDBInstanceViaEndpoint	透過連線位址取得執行個體資訊。	透過執行個體的連線位址取得執行個體的基本資訊。
ModifyDBInstanceConfig	修改執行個體設定項目。	呼叫 ModifyDBInstanceConfig 介面修改執行個體設定項目。
ModifyDBInstanceDescription	修改執行個體描述。	呼叫 ModifyDBInstanceDescription 介面修改執行個體備註描述。
ReleaseInstancePublicConnection	釋放執行個體的公網連線地址。	呼叫 ReleaseInstancePublicConnection 介面以釋放執行個體的公網連線。
RestartDBInstance	重新啟動執行個體。	呼叫 RestartDBInstance 介面重新啟動執行個體。
UpgradeDBInstanceKernelVersion	升級資料庫執行個體核心版本。	呼叫 UpgradeDBInstanceKernelVersion 介面更新執行個體核心版本。
ModifyDBInstanceClass	ModifyDBInstanceClass	呼叫 ModifyDBInstanceClass 介面修改執行個體規格。
UpdatePolarDBXInstanceNode	更新節點。	呼叫 UpdatePolarDBXInstanceNode 介面變更執行個體節點數，包括擴容和縮容。該請求會產生交易訂單。
ChangeResourceGroup	修改執行個體資源群組。	修改執行個體資源群組。
DescribeTransformStatus	查詢執行個體升級狀態	該介面主要用於查詢標準版執行個體向企業版執行個體升級（或轉換）任務的目前狀態。
DescribePolarxDataNodes	檢視資料節點資訊。	該介面用於查詢 PolarDB-X 執行個體中所有資料節點（Data Nodes）的詳細資訊，包括節點狀態、儲存使用情況、網路位址等，便於維運管理和監控。
ModifyDBInstanceMaintainTime	修改執行個體可維護時間。	修改執行個體可維護時間。
ModifyDBInstanceVip	修改執行個體虛擬 IP	該介面用於修改資料庫執行個體繫結的虛擬 IP（Virtual IP）位址或其網路屬性，支援更換內網 IP、調整子網、遷移可用區等操作。
DescribeRdsVpcs	查詢 VPC 清單。	PolarDB-X 端查詢 VPC 清單的 API。
DescribeRdsVswitches	查詢 Vswitch 清單。	該介面用於查詢 RDS 執行個體可用的專有網路（VPC）交換器（vSwitch）清單。
DescribeShowStorageInfo	查詢儲存空間資訊。	查詢執行個體的儲存空間使用詳情，包括總容量、已用空間、剩餘空間等資訊。
DescribeStoragePoolInfo	查詢儲存池資訊。	該介面用於查詢儲存池的詳細資訊，包括容量、使用情況、狀態等。
CreateStoragePool	建立儲存集區。	建立資源儲存集區。
CreateCustomEndpoint	建立自訂終端。	此介面用於為資料庫執行個體建立自訂的連線位址（Endpoint）。
DescribeCustomEndpointList	查詢自訂網域列表。	查詢自訂網域列表。
ModifyCustomEndpointNet	修改自訂網路端點。	該介面用於修改自訂網路端點的子網路、安全性群組及公網存取等網路設定。
DeleteCustomEndpoint	刪除用戶端網域。	刪除用戶端網域。
ModifyCustomEndpoint	修改自訂端點地址。	此介面用於修改自訂叢集地址（Custom Endpoint）的設定。
ModifyDBInstanceConnectionString	修改執行個體位址連結字串。	修改執行個體位址連結字串。
AllocateInstancePublicConnection	申請外網連線位址。	呼叫 AllocateInstancePublicConnection 介面建立公網 IP。
AllocateColdDataVolume	AllocateColdDataVolume	呼叫 AllocateColdDataVolume 介面。
ReleaseColdDataVolume	ReleaseColdDataVolume	呼叫 ReleaseColdDataVolume 介面。

監控與日誌

API	標題	API概述
DescribeSlowLogRecords	查詢慢日誌明細。	支援查詢 PolarDB-X 計算節點和儲存節點的慢 SQL 明細。
DescribeDBNodePerformance	查詢執行個體效能資料。	呼叫 DescribeDBNodePerformance 介面查詢執行個體效能資料。
DescribeSqlAuditInfo	檢視 SQL 稽核資訊。	此介面用於檢視 SQL 稽核資訊。
EnableSqlAudit	啟用 SQL 稽核。	啟用 SQL 稽核功能。
DisableSqlAudit	關閉 SQL 審計。	關閉 SQL 審計功能。
CheckSqlAuditSlsStatus	校驗稽核狀態。	該介面用於檢查指定資料庫執行個體的 SQL 稽核日誌是否已成功接入 SLS（阿里雲端日誌服務，Log Service）。呼叫後，系統會返回目前執行個體的 SQL 稽核功能與 SLS 的連線狀態、專案（Project）和日誌庫（Logstore）設定資訊、同步是否正常等。
DescribeEvents	取得歷史事件。	取得歷史事件。
DescribeActiveOperationMaintainConf	顯示維運時間設定。	呼叫 DescribeActiveOperationMaintainConf 介面以顯示維運時間設定。
DescribeActiveOperationTasks	取得維運事件。	呼叫 DescribeActiveOperationTasks 介面取得維運事件。
DescribeActiveOperationTaskCount	取得維運事件總數。	取得維運事件總數。
ModifyActiveOperationMaintainConf	修改維運事件時間設定。	呼叫 ModifyActiveOperationMaintainConf 介面修改維運事件時間設定。

任務管理

API	標題	API概述
DescribeTasks	取得執行個體任務清單。	取得執行個體任務清單。
DescribeScaleOutMigrateTaskList	展示資料遷移任務進度。	展示 ScaleOut 遷移任務進度。
CreateTransformOperation	建立轉換任務。	建立轉換任務，用於變更執行個體的某種狀態或設定。
DescribeRplInspectionTask	取得執行個體巡檢任務。	該介面用於查詢執行個體的複製延遲巡檢任務的詳細資訊。
SkipCurrentStep	跳過目前步驟。	此介面用於跳過目前步驟。
CreateRplInspectionTask	複製鏈路健康檢查。	在資料移轉過程中，用於複製鏈路健康檢查。
CancelActiveOperationTasks	取消維運事件任務。	呼叫 CancelActiveOperationTasks 介面取消維運事件任務。
ModifyActiveOperationTasks	修改維運事件執行時間。	呼叫 ModifyActiveOperationTasks 介面修改維運事件執行時間。

SSL加密

API	標題	API概述
UpdateDBInstanceSSL	更新執行個體 SSL 設定。	更新執行個體 SSL 設定。

參數管理

API	標題	API概述
ModifyParameter	修改執行個體參數。	呼叫 ModifyParameter 介面修改執行個體參數，包括運算層和儲存層。
DescribeParameterTemplates	檢視參數範本詳情。	呼叫 DescribeParameterTemplates 介面取得執行個體參數範本清單。
DescribeParameters	取得參數清單。	呼叫 DescribeParameters 介面取得執行個體參數。
DescribeParameterGroups	查詢參數群組資訊。	此介面用於查詢使用者建立或系統支援的資料庫參數群組清單，包括各參數群組的基本資訊、關聯引擎類型及修改時間等。

備份管理

API	標題	API概述
CreateBackup	建立備份。	呼叫 CreateBackup 介面建立備份。
DescribeBackupPolicy	查詢執行個體備份設定。	呼叫 DescribeBackupPolicy 介面查詢執行個體備份設定。
DescribeBackupSetList	檢視備份集清單。	呼叫 DescribeBackupSetList 介面檢視備份集清單。
DescribeBinaryLogList	查詢 Binlog 日誌。	呼叫 DescribeBinaryLogList 介面查詢 Binlog 日誌。
UpdateBackupPolicy	修改執行個體備份策略。	呼叫 UpdateBackupPolicy 介面修改執行個體備份策略。
DescribeOpenBackupSet	獲取用於線下恢復的備份集資訊	開放商業備份集的實例拓撲資訊和下載連結，滿足線下恢復雲上實例的需要。
DescribeBackupSet	DescribeBackupSet	呼叫 DescribeBackupSet 介面查看備份集詳情。

資料安全

API	標題	API概述
UpdateDBInstanceTDE	啟用執行個體 TDE。	呼叫 UpdateDBInstanceTDE 介面以啟用執行個體 TDE。
ModifySecurityIps	修改執行個體白名單。	呼叫 ModifySecurityIps 介面修改執行個體白名單。
DescribeUserEncryptionKeyList	取得使用者 TDE 金鑰清單。	呼叫 DescribeUserEncryptionKeyList 介面取得使用者 TDE 金鑰清單。
DescribeSecurityIps	檢視執行個體白名單資訊。	呼叫 DescribeSecurityIps 介面檢視執行個體白名單。
CheckCloudResourceAuthorized	KMS 金鑰授權驗證。	呼叫 CheckCloudResourceAuthorized 介面查詢 PolarDB-X 執行個體是否已被授權使用 KMS 金鑰服務。
EnableRightsSeparation	EnableRightsSeparation	啟用三權分立。
DisableRightsSeparation	DisableRightsSeparation	關閉三權分立。

帳號管理

API	標題	API概述
ResetAccountPassword	ResetAccountPassword	重設帳號密碼。
CreateAccount	建立普通帳號。	呼叫 CreateAccount 介面建立帳號。
CreateSuperAccount	建立高權限帳號。	呼叫 CreateSuperAccount 介面建立高權限帳號，一個執行個體只能有一個高權限帳號。
DeleteAccount	刪除執行個體帳號。	呼叫 DeleteAccount 介面刪除帳號。
DescribeAccountList	查詢執行個體帳號資訊。	呼叫 DescribeAccountList 介面取得帳號列表。
ModifyAccountDescription	修改執行個體的帳號描述資訊。	呼叫 ModifyAccountDescription 介面修改帳號備註描述。
ResetAccountPasswordRestrict	重設帳號密碼。	重設帳號密碼。
ModifyAccountPrivilege	ModifyAccountPrivilege	修改一般帳號的權限。

地域

API	標題	API概述
DescribeRegions	檢視可選的地域和可用區。	呼叫 DescribeRegions 介面取得地域清單。
MigrateDBInstance	實例可用區遷移	該介面用於將實例從一個可用區遷移到另一個可用區。
DescribeAvailableCrossRegions	查詢跨可用區。	該介面用於查詢支援跨區域操作的可用區域清單，通常用於多區域部署或資料複製場景。
DescribeEnabledCrossRegions	查詢已啟用的跨可用區。	該介面用於查詢目前啟用的跨可用區。

資料庫管理

API	標題	API概述
CreateDB	建立資料庫。	呼叫 CreateDB 介面建立資料庫。
DeleteDB	刪除資料庫。	呼叫 DeleteDB 介面刪除資料庫。
DescribeCharacterSet	查詢字元集。	呼叫 DescribeCharacterSet 介面查詢目標執行個體下資料庫所支援的字元集類型。
DescribeDbList	查詢取得執行個體下的資料庫資訊。	呼叫 DescribeDbList 介面取得資料庫清單。
DescribeDistributeTableList	取得資料庫表清單。	呼叫 DescribeDistributeTableList 介面取得資料庫表清單。
ModifyDatabaseDescription	修改資料庫描述。	呼叫 ModifyDatabaseDescription 介面修改資料庫備註描述。
StartSwitchDatabase	開啟資料庫切換。	該介面主要用於在資料庫遷移或同步任務的資料庫切換。
DescribeComponentPropeties	查詢元件屬性。	該介面用於取得指定元件的屬性資訊，包括屬性名稱、類型等。
ModifyEngineMigration	修改引擎移轉。	此介面用於修改資料庫引擎移轉任務的設定或移轉參數，支援調整來源資料庫、目標資料庫、移轉物件或移轉模式等設定。

CDC管理

API	標題	API概述
UpgradeCDCVersion	升級 CDC 版本。	升級 PolarDB-X CDC 節點版本。
DescribeCdcInfo	查詢 CDC 執行個體資訊。	查詢 CDC 資訊。
DescribeCdcVersionList	CDC 版本取得。	取得 CDC 版本清單。
DescribeCdcClassList	規格清單。	查詢執行個體規格清單。
ModifyCdcClass	修改 CDC 配置。	修改 CDC 配置。

列存管理

API	標題	API概述
AttachColumnarInstance	掛載欄位儲存。	此介面用於將一個欄位儲存執行個體（Columnar Instance）掛載到指定的主資料庫執行個體上。
UpgradeColumnarVersion	更新欄存版本。	更新欄存版本。
ModifyColumnarClass	修改列存規格。	修改列存規格。
DescribeColumnarVersionList	查詢欄存版本資訊。	查詢欄存版本資訊。
DescribeColumnarInfo	查詢列存資訊。	查詢列存資訊。
DescribeColumnarClassList	查詢列存規格清單。	查詢執行個體列存規格清單。

資料移轉與同步

API	標題	API概述
DescribeEvaluateAndImportTask	查詢評估匯入任務清單。	查詢 PolarDB-X 評估匯入任務的清單。（單個）
DescribeEvaluateAndImportTasks	查詢評估匯入任務清單。	查詢 PolarDB-X 評估匯入任務的清單。（多個）
DeleteEvaluateAndImportTask	刪除評估匯入任務。	刪除評估匯入任務。
CreateSQLEvaluateTask	SQL 評估。	用於建立 SQL 語句評估任務，透過此介面，使用者提交 SQL 語句，系統將對其進行靜態分析與風險評估，輸出其在目標資料庫執行個體上的執行風險、相容性問題。
CreateStructureImportTask	建立資料結構匯入任務。	用於建立資料庫結構匯入任務，支援將包含 DDL 語句的 SQL 指令碼檔案或文字內容匯入到目標資料庫執行個體中，自動執行建表、建立索引、檢視表、預存程序等結構化操作。
DescribeDataImportTaskInfo	取得資料匯入任務資訊。	查詢資料匯入任務的執行詳情。
CloseEngineMigration	關閉引擎遷移。	此介面用於關閉指定執行個體的資料庫引擎遷移流程。當使用者啟動從其他資料庫（如自建 MySQL、RDS 等）向 PolarDB-X 的資料遷移任務後，若需中途終止或清理遷移狀態，可透過此介面安全停止遷移過程。
ConfirmNoConnection	回滾切換時確認無連線。	回滾切換時確認無連線。
RestartDataImportTask	重新啟動資料匯入任務。	重新啟動資料匯入任務。
StopDataImportTask	停止資料匯入任務。	該介面用於停止資料匯入。
CreateDataImportTask	建立資料匯入任務。	用於建立一個資料匯入任務，將外部資料檔案（如 SQL 指令碼、CSV 檔案等）匯入到目標資料庫執行個體中。
DescribeStructureImportTaskInfo	查詢資料匯入任務資訊。	此介面用於查詢資料庫結構匯入任務的詳細資訊。
RefreshImportMeta	重新整理匯入中繼資料。	此介面用於重新整理匯入任務的中繼資料資訊。

GDN管理

API	標題	API概述
DeleteGdnInstance	刪除 GDN 執行個體。	刪除 GDN 執行個體。
DescribeGdnInstances	取得 GDN 執行個體清單資訊。	取得 GDN 執行個體清單。
SwitchGdnMemberRole	GDN 主備切換。	GDN 主備切換。
CreateGdnInstance	建立 GDN 執行個體。	建立 GDN 執行個體。

SQL閃回

API	標題	API概述
SubmitSqlFlashbackTask	建立 SQL 閃回任務。	呼叫 SubmitSqlFlashbackTask 介面建立 SQL 閃回任務。
PreCheckSqlFlashbackTask	SQL 閃回恢復檢查。	該介面用於在執行 SQL 閃回恢復（Flashback）前，對恢復任務進行前置檢查與可行性評估。
DescribeSqlFlashbackTaskList	檢視 SQL 閃回任務的清單。	呼叫 DescribeSqlFlashbackTaskList 介面檢視 SQL 閃回任務的清單。

標籤管理

API	標題	API概述
DescribeTags	取得標籤資訊。	取得標籤資訊。
ListTagResources	標籤清單取得。	標籤清單取得。
TagResources	為資源加上標籤。	呼叫 TagResources 介面為資源加上標籤。
UntagResources	資源刪除標籤。	資源刪除標籤。

其他

API	標題	API概述
CheckHealth	CheckHealth	進行服務健康度檢測。
RestoreDBInstance	復原執行個體。	複製 PolarDB-X 執行個體。
CreateMem0	開通記憶引擎	開通記憶引擎
DescribeMem0Info	查看記憶引擎資訊	查看記憶引擎資訊。
DeleteMem0	關閉記憶引擎	關閉記憶引擎。
CreateGdnStandbyMember	新增 GDN 從執行個體。	新增 GDN 從執行個體。
CreateSubCNInstance	建立自訂地址。	建立自訂地址。
UpdateCustinsParam	修改執行個體標籤。	修改執行個體標籤。
DescribeDBInstanceEndpoint	檢視自訂地址。	檢視自訂地址。
DeleteSubCNInstance	刪除自訂地址。	刪除自訂地址。
CreateGatewayConsumerForPolarDBX	開啟執行個體 AI 能力	為 PolarDB-X 執行個體建立 AI 閘道 Consumer。
ResetMem0AccountPassword	重設記憶引擎 API KEY	重設記憶引擎 API KEY
DescribeMem0SecurityIps	檢視記憶體引擎白名單	查詢記憶體引擎白名單
ModifyMem0SecurityIps	修改記憶引擎白名單	修改記憶引擎白名單
AllocateMem0PublicConnection	開通記憶引擎公網地址	為 Mem0 執行個體開通公網域名。
ReleaseMem0PublicConnection	關閉記憶引擎公網地址	為 Mem0 執行個體釋放公網網域名稱
DescribeSupabaseInstanceAttribute	查詢 Supabase 執行個體詳情。	查詢 Supabase 執行個體詳情。
DescribeSupabaseIpWhitelist	查詢 Supabase IP白名單。	查詢Supabase IP白名單。
DeleteSupabaseNetType	關閉 Supabase 公網。	釋放Supabase公網地址。
CreatePolardbxSupabaseInstance	建立 Supabase 執行個體。	建立 Supabase 執行個體。
ModifySupabaseDashboardPassword	修改 Supabase Dashboard 密碼。	修改 Supabase Dashboard 密碼。
RestartSupabaseInstance	重新啟動 Supabase 執行個體。	重新啟動 Supabase 執行個體。
CreateSupabaseNetType	開通Supabase公網。	開通Supabase公網地址。
DescribeSupabaseApiKey	查詢Supabase API Key。	查詢Supabase API Key。
ModifySupabaseSecurityIPList	修改 Supabase IP 白名單。	修改 Supabase IP 白名單。
DescribeSupabaseInstances	查詢 Supabase 執行個體列表。	查詢Supabase執行個體列表。
DeletePolardbxSupabaseInstance	刪除 Supabase 執行個體。	刪除 Supabase 執行個體。

其他

API	標題	API概述
AllocateContext0PublicConnection	開通上下文服務公網連線。	為上下文服務指定實體 ReplicaSet 開通公網連線。
AllocateContextDBPublicConnection	開通上下文服務公網。	為 ContextDB-X 服務 ReplicaSet 開通公網連線。
AllocatePxfsPublicConnection	開通Agent檔案服務公網連線。	開通 PXFS 公網連線。
CreateContext0	建立內容服務。	建立內容服務。
CreateContextDB	建立上下文服務。	建立 ContextDB-X。
CreateOpenSearch	建立 PolarDBX Search 執行個體。	建立 PolarDBX Search 執行個體。
CreateOpenSearchAccount	建立 PolarDBX Search 執行個體帳號。	建立 PolarDBX Search 執行個體帳號。
CreateOpenSearchWhitelistGroup	建立 PolarDBX Search 白名單分組。	新增 PolarDBX Search 白名單分組。
CreatePxfs	建立Agent檔案服務執行個體。	建立Agent檔案服務執行個體。
CreatePxfsAccessToken	簽發Agent檔案服務存取Token。	簽發Agent檔案服務存取Token。
CreatePxfsTenant	建立Agent檔案服務租戶。	建立Agent檔案服務租戶。
CreatePxfsUser	建立Agent檔案服務租戶身分。	建立Agent檔案服務租戶身分。
CreatePxfuse	建立 Agent 觀測服務。	建立 PXFuse 節點。
CreateServiceAccount	建立服務帳號。	建立服務帳號。
DeleteContext0	刪除上下文服務。	刪除上下文服務。
DeleteContextDB	刪除上下文服務。	刪除 ContextDB-X。
DeleteOpenSearch	釋放 PolarDBX Search 執行個體。	釋放 PolarDBX Search 執行個體。
DeleteOpenSearchAccount	刪除 PolarDBX Search 執行個體帳號。	刪除 PolarDBX Search 執行個體帳號。
DeleteOpenSearchWhitelistGroup	刪除 PolarDBX Search 白名單分組。	刪除 PolarDBX Search 白名單分組。
DeletePxfs	刪除Agent檔案服務執行個體。	刪除Agent檔案服務執行個體。
DeletePxfsUser	刪除Agent檔案服務租戶身分。	刪除Agent檔案服務租戶身分。
DeletePxfuse	刪除 Agent 觀測服務。	刪除 PXFuse 節點。
DeleteServiceAccount	刪除服務帳號。	刪除服務帳號。
DescribeContext0Config	查詢上下文服務配置。	查詢上下文服務管理憑證。
DescribeContext0Info	查詢上下文服務執行個體資訊。	查詢上下文服務執行個體資訊。
DescribeContext0SecurityIps	查詢上下文服務白名單。	查詢上下文服務白名單。
DescribeContextDBConfig	檢視上下文服務設定。	查詢 ContextDB-X 管理憑證。
DescribeContextDBInfo	檢視上下文服務。	查詢 ContextDB-X 執行個體資訊。
DescribeContextDBSecurityIps	檢視上下文服務白名單	查詢 ContextDB-X 白名單。
DescribeOpenSearchAccountInfo	查詢 PolarDBX Search 帳號資訊。	查詢 PolarDBX Search 帳號資訊。
DescribeOpenSearchConnectionInfo	查詢 PolarDBX Search 連線資訊。	查詢 PolarDBX Search 連線資訊（內網/公網/Dashboard 地址及協定）
DescribeOpenSearchInfo	查詢 PolarDBX Search 執行個體資訊。	查詢 PolarDBX Search 執行個體資訊。
DescribeOpenSearchInstances	查詢 PolarDBX Search 執行個體清單。	查詢 PolarDBX Search 執行個體清單。
DescribeOpenSearchNodes	查詢 PolarDBX Search 節點清單。	查詢 PolarDBX Search 節點清單。
DescribeOpenSearchResourceUsage	查詢 PolarDBX Search 叢集資源使用情況。	查詢 PolarDBX Search 叢集資源使用情況。
DescribeOpenSearchTopology	查詢 PolarDBX Search 叢集節點拓撲。	查詢 PolarDBX Search 叢集節點拓撲。
DescribeOpenSearchWhitelists	查詢 PolarDBX Search 白名單清單。	查詢 PolarDBX Search 白名單清單（支援按網路類型篩選）
DescribePxfsAccessTokens	查詢Agent檔案服務存取Token。	查詢Agent檔案服務存取Token。
DescribePxfsInfo	查詢Agent檔案服務執行個體資訊。	查詢Agent檔案服務執行個體資訊。
DescribePxfsSecurityIps	查詢Agent檔案服務白名單。	查詢Agent檔案服務白名單。
DescribePxfsTenant	查詢Agent檔案服務租戶。	查詢Agent檔案服務租戶。
DescribePxfsUsers	查詢Agent檔案服務租戶身分。	查詢Agent檔案服務租戶身分。
DescribePxfuseInfo	檢視 Agent 觀測服務資訊。	查詢 PXFuse 執行個體資訊。
DescribePxfuseSecurityIps	檢視 Agent 觀測服務白名單。	查詢 PXFuse 執行個體白名單。
DescribeServiceAccount	查詢服務帳號狀態。	查詢服務帳號狀態。
DisableOpenSearchPublicEndpoint	關閉 PolarDBX Search 公網存取。	關閉 PolarDBX Search 公網存取。
EnableOpenSearchPublicEndpoint	開啟 PolarDBX Search 公網存取。	開通 PolarDBX Search 公網存取。
ExecuteMetaQuery	執行中繼資料唯讀查詢。	執行中繼資料查詢。
ModifyContext0SecurityIps	修改上下文服務白名單。	同步修改上下文服務 Service 和 Dashboard 白名單。
ModifyContextDBSecurityIps	修改上下文服務白名單。	修改 ContextDB-X 服務 ReplicaSet 白名單。
ModifyOpenSearchAccessProtocol	修改 PolarDBX Search 存取通訊協定。	切換 PolarDBX Search 存取通訊協定（HTTP/HTTPS）
ModifyOpenSearchClass	變更 PolarDBX Search 執行個體規格。	變更 PolarDBX Search 執行個體規格。
ModifyOpenSearchWhitelistGroup	修改 PolarDBX Search 白名單分組。	修改 PolarDBX Search 白名單分組。
ModifyPxfsSecurityIps	修改Agent檔案服務白名單。	修改Agent檔案服務白名單。
ModifyPxfuseSecurityIps	修改 Agent 觀測服務白名單。	修改 PXFuse 節點白名單。
QueryColumnarLog	查詢欄存稽核日誌。	查詢欄存稽核日誌。
QueryColumnarLogSSE	串流查詢欄存稽核日誌。	串流查詢完整欄存稽核日誌。
ReleaseContext0PublicConnection	釋放上下文服務公網連線。	關閉上下文服務指定實體 ReplicaSet 公網連線。
ReleaseContextDBPublicConnection	釋放上下文服務公網。	關閉 ContextDB-X 服務 ReplicaSet 公網連線。
ReleasePxfsPublicConnection	關閉Agent檔案服務公網連線。	關閉Agent檔案服務公網連線。
ResetOpenSearchPassword	重置 PolarDBX Search 執行個體帳號密碼。	重置 PolarDBX Search 執行個體密碼（無需舊密碼，需 RAM 權限驗證）
RestartOpenSearch	重新啟動 PolarDBX Search 執行個體。	重新啟動 PolarDBX Search 執行個體。
RestartPxfs	重啟Agent檔案服務執行個體。	重啟Agent檔案服務執行個體。
RevokePxfsAccessToken	撤銷Agent檔案服務存取Token。	撤銷Agent檔案服務存取Token。
ScaleInOpenSearch	縮減 PolarDBX Search 執行個體。	PolarDBX Search 叢集縮減節點。
ScaleOutOpenSearch	擴容 PolarDBX Search 執行個體。	PolarDBX Search 叢集擴容節點。
UpgradePxfsVersion	升級Agent檔案服務小版本。	升級Agent檔案服務小版本。