API 概覽
更新時間：
Copy as MD
API標準及多語言預置SDK
本產品（Hologram/2022-06-01）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
升級
|
API |
標題 |
API概述 |
| GetUpgradeStatus | 查詢升級狀態 | 查詢升級狀態 |
| GetLastUpgradeRecord | 查詢升級記錄 | 擷取上次升級歷史 |
| UpdateAutoUpgrade | 開啟小版本自動升級 | 開啟小版本自動升級。開啟後，將在營運時間視窗自動升級執行個體 |
| UpdateOperationEventScheduleTime | 更新營運事件執行時間 | 修改營運事件執行時間 |
| UpdateMaintenanceWindow | 設定可維護時間視窗 | 用於設定執行個體的可維護時間段，以便進行系統維護。 |
| PrepareUpgrade | 升級準備 | 啟動升級前的準備。升級前需要做一輪評估，評估通過，則可以升級，否則需要連絡人工升級。 |
| DiscardUpgrade | 取消升級 | 取消升級.請求條件：只在還未開始或者處於pre_check狀態的任務按鈕不置灰，顯示為取消升級。一旦進入backup狀態或者之後的狀態，就不允許取消了。 |
標籤
|
API |
標題 |
API概述 |
| UntagResources | 刪除執行個體標籤 | 刪除執行個體標籤 |
| TagResources | 新增執行個體標籤 | 新增tag |
| DescribeTags | 列出所有標籤 | 列出所有標籤 |
執行 SQL
|
API |
標題 |
API概述 |
| GetExecuteStatementEnabled | 查詢執行個體是否開啟ExecuteStatement功能 | 檢查指定Hologres執行個體是否已開啟通過OpenAPI執行SQL的功能。 |
| ExecuteStatement | 執行SQL語句 | 通過OpenAPI在指定資料庫上同步執行SQL語句並返回結果。 |
| EnableExecuteStatement | 開啟執行個體SQL執行API | 為指定Hologres執行個體啟用通過OpenAPI執行SQL的功能。 |
| DisableExecuteStatement | 停用執行個體的 ExecuteStatement 功能。 | 關閉指定 Hologres 執行個體的 ExecuteStatement API 存取權限。 |
大模型
|
API |
標題 |
API概述 |
| ListInstanceModel | AI 節點資源列表 | AI 節點資源列表。 |
| UpdateModelService | 更新模型服務 | 建立模型服務，只適用於Hologres AI |
| ListModelCatalog | 模型列表 | 模型列表 |
| DeleteModelResource | 刪除節點資源 | 刪除節點資源，節點部署的所有模型將被刪除，不可恢複。 |
| DeleteModelService | 刪除模型服務 | 刪除模型服務 |
資料庫
|
API |
標題 |
API概述 |
| CreateDatabase | 建立資料庫 | 建立db |
| CreateExternalDatabase | 建立外部資料庫 | 建立外部db |
| CreateUser | 建立使用者 | 將Ram子帳號/STS帳號添加到Hologres執行個體，作為執行個體帳號使用，添加後，即可以Ram/STS身份登陸執行個體。 |
| DropUser | 刪除使用者 | 將Ram子帳號/STS帳號從Hologres帳戶體系刪除，刪除後，Ram/STS不能再登陸執行個體。如需登陸執行個體，請用CreateUser重新添加。 |
| RevokeTablePermission | 撤銷表授權 | 取消表授權。 |
| RevokeSchemaPermission | 撤銷Schema授權 | 取消Schema授權。 |
| RevokeDatabasePermission | 撤銷資料庫授權 | 取消DB授權。 |
| ListDatabases | 資料庫列表 | 擷取DB列表。 |
| GrantTablePermission | 表授權 | DB授權。 |
| GrantSchemaPermission | Schema授權 | DB授權。 |
| GrantDatabasePermission | 資料庫授權 | DB授權。 |
執行個體
|
API |
標題 |
API概述 |
| BindLeaderInstance | 綁定從執行個體 | 綁定從執行個體 |
| ListLeaderInstances | 擷取主執行個體列表 | 擷取可能的主執行個體Id列表。 |
| UnBindLeaderInstance | 解除綁定主從執行個體 | 解除綁定主執行個體 |
| CreateInstance | 建立執行個體 | 該介面用於建立執行個體。 |
| DeleteInstance | 刪除執行個體 | 該介面用於釋放執行個體。 |
| RenewInstance | 執行個體續約 | 該介面用於為執行個體手動續約。可以在續約的同時開啟按月自動續約。 |
| RestartInstance | 重啟執行個體 | 該介面用於重啟Hologres執行個體。 |
| ResumeInstance | 恢複執行個體 | 恢複暫停執行個體。 |
| UpdateInstanceName | 修改執行個體名稱 | 該介面用於修改執行個體名稱。 |
| UpdateInstanceNetworkType | 切換執行個體的網路類型 | 該介面用於修改執行個體網路類型。 |
| DisableHiveAccess | 關閉資料湖加速 | 該介面用於關閉資料湖加速。 |
| EnableHiveAccess | 開啟資料湖加速 | 該介面用於開啟資料湖加速。 |
| StopInstance | 停止執行個體 | 該介面用於暫停執行個體。 |
| ScaleInstance | 執行個體變更配置 | 該介面用於變更執行個體的規格和儲存空間。 |
| ChangeResourceGroup | 更新資源群組 | 更新資源群組。 |
| ListInstances | 擷取執行個體列表 | 擷取執行個體列表。 |
| GetInstance | 擷取執行個體詳情 | 該介面用於擷取執行個體詳情。 |
計算組
|
API |
標題 |
API概述 |
| UpdateWarehouseScheduleTask | 更新計算群組分時彈性計劃 | 更新計算群組分時彈性計劃 |
| ListWarehouseScheduleTask | 計算群組分時彈性計劃列表 | 擷取指定執行個體下的所有計算群組分時彈性計劃工作清單。 |
| ListWarehouseScheduleEvent | 彈性事件列表 | 查詢指定執行個體在給定時間範圍內的彈性調度事件。 |
| CreateWarehouse | 建立Warehouse | 建立warehouse |
| CreateHoloWarehouse | 建立計算群組 | 建立計算群組。 |
| DeleteHoloWarehouse | 刪除計算群組 | 刪除計算群組。 |
| RebalanceHoloWarehouse | 計算群組均衡分區 | 計算群組均衡分區。 |
| ResumeHoloWarehouse | 恢複計算群組 | 從停機狀態恢複到正常狀態。 |
| SuspendHoloWarehouse | 停止計算群組 | 停止計算群組。 |
| RenameHoloWarehouse | 重新命名計算群組 | 重新命名計算群組。 |
| ScaleHoloWarehouse | 變更配置計算群組 | 計算群組擴縮容。 |
| RestartHoloWarehouse | 重啟計算群組 | 重啟計算群組。 |
| GetWarehouseDetail | 計算群組詳情 | 計算群組的詳細資料。 |
| CreateWarehouseScheduleTask | 建立分時彈性計劃 | 建立分時彈性計劃 |
| ListWarehouses | 計算群組列表 | 擷取計算群組列表。 |
| DisableWarehouseAutoScale | 關閉自動彈性 | 關閉自動彈性 |
| DeleteWarehouseScheduleTask | 刪除計算群組彈性計劃 | 刪除計算群組彈性計劃 |
| EnableWarehouseAutoScale | 開啟自動彈性 | 開啟自動彈性 |
備份
|
API |
標題 |
API概述 |
| UpdateScheduledBackupConfig | 配置備份策略 | 配置備份策略。以周為周期，可以指定一周內的數個固定日期啟動執行個體備份，比如周一、周三、周五的20:00:00。已完成的備份，可以配置保留個數，到期的備份會被自動清理。 |
| UpdateBackupDataDesc | 修改備份描述 | 更新備份描述 |
| CreateManualBackup | 建立執行個體備份 | 建立執行個體備份。 |
| ListBackupData | 查詢備份列表 | 該介面用於查詢備份資料列表。一份備份是對執行個體截止快照時間的全量資料快照，可以通過新購執行個體完全恢複原來的資料。 |
| DeleteBackupData | 刪除執行個體備份 | 刪除備份 |
| GetScheduledBackupConfig | 擷取備份配置 | 擷取備份配置。 |
安全
|
API |
標題 |
API概述 |
| UpdateInstancePort | 修改執行個體連接埠號碼 | 修改連接埠號碼 |
| UpdateHoloWebLoginSetting | 修改holoweb登陸許可權 | 修改holoweb登陸許可權 |
| GetHoloWebLoginSetting | 查詢HoloWeb登入許可權 | 擷取holoweb登陸許可權 |
| DisableSupportAccount | 關閉服務帳號 | 關閉服務帳號 |
| EnableSupportAccount | 開啟服務帳號 | 開啟服務帳號 |
| EnableSSL | 開啟SSL | 開啟SSL |
| DisableSSL | 關閉SSL | 關閉SSL。 |
| GetCertificateAttribute | 查看執行個體認證屬性 | 獲得認證資訊。 |
| GetRootCertificate | 下載認證 | 擷取根憑證。 |
| RenewSSLCertificate | 更新認證 | 更新SSL認證。 |
其他
|
API |
標題 |
API概述 |
| ListMigrationZones | 查詢可遷移可用性區域 | 查詢可以遷移可用性區域。3AZ執行個體，可以在可用性區域之間自助遷移。 |
| ListOperationEvents | 查詢操作事件列表 | 擷取指定條件下的操作事件列表，支援分頁和排序。 |
| MigrateInstanceZone | 遷移執行個體 | 遷移執行個體到目標可用性區域。僅3AZ執行個體支援，無需遷移儲存，直接在目標可用性區域啟動執行個體，大約5分鐘。 |
该文章对您有帮助吗？