本產品(
數據管理 - 數據庫網關/2023-09-14
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(11370001915),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
API目錄
API | 標題 | API概述 |
---|---|---|
CreateGateway | 創建網關 | 調用此API創建一個全新的數據庫網關。 |
AddDatabase | 通過DG接入數據庫 | 調用此API可以將他云或本地的數據庫接入至阿里云。 |
AddDatabaseList | 通過DG批量接入數據庫 | 調用此API可以在網關中批量添加數據庫。 |
CheckDGEnabled | 檢查當前用戶是否開通數據庫網關產品 | 調用此API可以檢查當前用戶是否開通數據庫網關產品。 |
ConnectDatabase | 數據庫連通性測試 | 調用此API對數據庫連通性進行測試。 |
CreateGatewayVerifyCode | 生成線下安裝網關時需要的驗證碼 | 調用此API可以生成線下安裝網關時需要的驗證碼。該驗證碼將與云上創建的網關相對應。 |
DeleteDatabase | 刪除數據庫 | 調用此API可刪除數據庫網關中添加的數據庫。 |
DeleteGateway | 刪除網關 | 調用此API可以刪除指定網關。 |
DeleteGatewayInstance | 刪除網關節點 | 調用此API可以刪除指定的數據庫網關節點。 |
DescribeRegions | 獲取數據庫網關支持的地域 | 調用此API可以獲取支持創建數據庫網關的地域。 |
DownloadGatewayProgram | 獲取網關程序的下載地址 | 調用此API可以獲取網關程序的下載地址。阿里云用戶均可下載,無需權限認證。 |
FindUserGatewayById | 獲取網關的詳細信息 | 調用此API可以獲取網關的詳細信息,包括網關的創建人、運行中的網關節點數量等信息。 |
GetUserDatabases | 獲取網關中的數據庫列表 | 調用此API可以查看指定網關中已添加的數據庫列表信息。 |
GetUserGatewayInstances | 獲取網關節點詳細信息 | 調用此API可以獲取網關節點的詳細信息。 |
GetUserGateways | 獲取網關列表 | 調用此API可以獲取用戶創建的DG網關列表。 |
ListDatabaseAccessPoint | 獲取數據庫訪問點列表 | 調用此API可以獲取數據庫訪問點列表。 |
ModifyDatabase | 修改數據庫信息 | 調用此API可以修改數據庫描述等信息。 |
ModifyGateway | 修改網關的基本信息 | 調用該API可以修改網關的基本信息,包含網關名稱和網關描述。 |
RetryDatabase | 重新連接數據庫 | 調用此API可以使數據庫網關重新連接數據庫。 |
StopGateway | 停止網關服務 | 調用此API可以停止網關服務。 |