本產品(
Elasticsearch Serverless服務/2023-06-27
)的OpenAPI采用ROA簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(11370001915),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
應用
API | 標題 | API概述 |
---|---|---|
CreateApp | 創建應用 | 調用CreateApp接口,創建Elasticsearch Serverless應用。 |
UpdateApp | 更新應用 | 調用UpdateApp接口,更新Elasticsearch Serverless應用相關信息,包括備注、網絡開關、IP白名單組、賬號密碼等。 |
GetApp | 獲取應用詳情 | 調用GetApp接口,獲取Elasticsearch Serverless應用的詳情信息。 |
ListApps | 應用列表 | 調用ListApps接口,查看Elasticsearch Serverless應用的列表。 |
DeleteApp | 刪除應用 | 調用DeleteApp接口,刪除Elasticsearch Serverless應用。 |
GetAppQuota | 查看應用配額 | 調用GetAppQuota接口,獲取Elasticsearch Serverless應用的配額信息。 |
GetMonitorData | 獲取應用監控數據 | 調用GetMonitorData接口,獲取Elasticsearch Serverless應用監控的指標數據。 |
ListIndices | 查看索引列表 | 調用ListIndices接口,查看ES Serverless應用的索引列表。 |
數據備份
API | 標題 | API概述 |
---|---|---|
CreateSnapshot | 創建快照 | 調用CreateSnapshot,創建ES Serverless應用的快照。 |
UpdateSnapshotSetting | 修改自動備份配置 | 調用UpdateSnapshotSetting接口,修改ES Serverless應用自動備份快照的配置。 |
ListSnapshots | 獲取快照列表 | 調用ListSnapshots接口,獲取ES Serverless應用的快照列表。 |
ListSnapshotRepositories | 獲取快照備份倉庫列表 | 調用ListSnapshotRepositories接口,獲取ES Serverless應用快照的備份倉庫列表。 |
GetSnapshotSetting | 獲取自動備份配置 | 調用GetSnapshotSetting接口,獲取ES Serverless應用的自動備份配置。 |
DeleteSnapshot | 刪除快照 | 調用DeleteSnapshot接口,刪除ES Serverless應用快照。 |
詞典
API | 標題 | API概述 |
---|---|---|
UpdateDict | 創建或修改詞典 | 調用UpdateDict接口,創建或修改ES Serverless應用詞典。目前僅支持通過OSS地址上傳。 |
ListDicts | 獲取詞典列表 | 調用ListDicts接口,獲取ES Serverless應用的詞典列表。 |
DeleteDict | 刪除詞典 | 調用DeleteDict接口,刪除ES Serverless應用的詞典。 |
終端節點
API | 標題 | API概述 |
---|---|---|
CreateEndpoint | 創建終端節點 | 調用CreateEndpoint接口,創建ES Serverless應用的私網終端節點。目前僅支持創建VPC類型的端點,用來打通用戶VPC網絡和ES Serverless服務的網絡。調用該接口會默認幫助用戶創建AliyunServiceRoleForESServerless角色。 |
UpdateEndpoint | 修改終端節點信息 | 調用UpdateEndpoint接口,修改ES Serverless平臺中創建的終端節點。 |
ListEndpoints | 獲取終端節點列表 | 調用ListEndpoints接口,獲取在ES Serverless平臺創建的VPC終端節點列表。 |
DeleteEndpoint | 刪除終端節點 | 調用DeleteEndpoint接口,刪除在ES Serverless平臺創建的終端節點。 |
規格審批任務
API | 標題 | API概述 |
---|---|---|
ListSpecReviewTasks | 查看規格審批工單列表 | 調用ListSpecReviewTasks,查看ES Serverless應用中申請修改規格的審批工單列表。 |
GetSpecReviewTask | 查看規格審批工單詳情 | 調用GetSpecReviewTask接口,查看ES Serverless應用的規格審批工單詳情。 |
CancelSpecReviewTask | 撤銷審批工單 | 調用CancelSpecReviewTask接口,撤銷ES Serverless應用規格審批工單。 |