GaussDB(DWS) 數據倉庫服務API Explorer的使用

API Explorer 介紹

API Explorer是華為云為開發者提供的一站式API解決方案統一平臺,集成華為云服務開放API,支持全量快速檢索、可視化調試、幫助文檔、幫助開發者(包括基于華為云開放API管理云資）更方便快捷的使用華為云服務。

API Explorer提供以下功能

1. API檢索

匯集了華為云多個產品的API，可以在此集中檢索，快速找到您所需要的API。

2. API調用

無需編寫代碼，在調用頁面中填寫請求參數，便可調用API。

3.查看API請求

根據您填寫的請求參數自動生成API請求，并打印到網頁上，讓您直觀的查看到真實發送的API請求。

4.結構化輸出返回結果

根據API請求，返回真實的API調用結果，結構化輸出。

API Explorer在GaussDB(DWS) 中的使用

進入API Explorer概覽頁面，在“搜索API或產品”搜索框輸入需要查詢的API接口或者服務(這里輸入“創建集群”或者DWS)，然后在下拉框列表中選中對應服務的API接口或者服務(數據倉庫服務對應的接口或服務)點擊，即可進入對應服務的DWS的API Explorer頁面

以下為進入后的DWS的API Explorer頁面，其中左側第二欄為數據倉庫服務的Open API接口，左側第三欄為接口調用參數輸入和接口的調試，最右側包含了CLI示例、調試結果、文檔、模擬數據、場景示例頁簽，功能分別為：

1. CLI示例

華為CLI命令行工具是基于華為云開放API構建工具，您可以在命令行中使用hcloud命令與華為云服務進行交互，管理您的華為云資源。華為云CLI提供了對華為云產品開放API的直接訪問，您可以基于華為云CLI開發Shell腳本，來管理和維護自己的華為云資源。?CLI用戶指南

2. 調試結果

接口調試的結果顯示，發起調試后，APIExplorer會使用已登錄賬號的臨時Token執行請求，部分接口調用涉及云產品計費，請謹慎操作

3. 文檔

用于對于左側接口的說明，包括URL格式、請求參數、請求示例、請求返回值的詳細描述

4.模擬數據

提供API真實調用模擬數據，支持在開發環境中驗證API請求結果，實現不同場景下API返回的邏輯處理。

5.場景示例

接口應用場景的列表，每行數據描述了當前接口實際的應用場景。

示例(查詢DWS集群列表)

1.在接口列表中選中對應的接口；

2.選擇服務需要執行接口的Region；

3.選擇對應的項目ID；

4.如果有body參數，輸入對應的body參數

5.點擊調試按鈕

經過以上步驟進行調試后，調試的結果會顯示在右側列表中，會把對應的請求數據的請求頭，請求體，響應結果的響應頭和響應體顯示在頁面。

對于參數疑問，也可以參考DWS接口文檔

API Explorer EI企業智能 Gauss AP 數據倉庫服務 GaussDB(DWS)

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。