kubernetes使用http rest api訪問叢集之使用postman工具訪問 apiserver

周國通發表於2019-06-27

系列目錄

前面一節我們介紹了使用curl命令列工具訪問apiserver,命令列工具快速高效,但是對於輸出非常長的內容檢視不是特別方便,尤其終端介面輸入的東西非常多的時候,過長的內容不是特別容易通過滾動快速定位到本次輸出內容的開始部分.也不便於複製到網頁線上json格式化工具裡檢視.命令列輸入過長的內容也更容易出錯.這裡推薦使用postman工具來請求介面.當然postman對於較長的json檢視也不是非常友好,但是我們可以通過ctrl+a複製所有內容,然後貼上到線上json檢視工具裡檢視.

工欲善其事,必先利其器.一個好的json檢視工具對我們請求apiserver(或者其它返回json型別資料的介面)檢視返回的json有著非常大的幫助作用.這裡介紹兩個工具一個是線上的,另一個是notepad++的一個外掛.

1) 線上json檢視工具

地址:http://www.bejson.com/jsonviewernew/

使用方法非常簡單,我們把想要檢視的json字串複製到貼上到指定區域內,點選格式化便可以對格式進行整理(kubernetes api返回的json為格式化過的,這裡不用再格式化).點選左上角的檢視標籤.我們便可以很清楚地看到json的整體結構

img

通過右邊皮膚可以看到都有哪些key

我們點選有+號的摺疊項,便可以通過右側的皮膚檢視到其裡面的鍵值

img

當然,我們也可以點選+號本身來展示選項,直接在左側檢視其包含的鍵值

img

如果摺疊項是陣列,我們點選加號很容易看清楚陣列裡元素的個數

img

想要檢視陣列裡元素的結構,展開其中任意一個即可.

2)Notepad++ jsonviewer外掛

notepad++是windows平臺下非常方便且功能強大的文字檢視工具,本身並沒有json格式整理功能,可以通過安裝json viewer工具來格式化json.

開啟Notepad++,在上面的選單裡選擇外掛(Plugins)->外掛管理(Plugins-Admin)這時候會出現一個外掛管理對話方塊,我們從中找到json viewer並安裝.

新版本notepad++不帶外掛管理功能,需要額外安裝.安裝方法檢視這裡

安裝完以後,我們把json複製到notepad++裡,然後執行外掛(Plugins)->JSON viewer->Format JSON便可以對json進行格式化.

img

還可以通過執行上圖中的Show JSON Viwer便可以調出一個單獨的視窗來檢視json的結構,和上面web裡差不多.

img

使用postman工具請求apiserver

下面我們進入正題,開始介紹如何通過postman工具請求apiserver

首先,我們通過scp等工具把上一節生成的myca.crt證書複製到windows機器上一份.然後雙擊開啟.便會出現一個安裝按鈕,一直下一步直到安裝成功即可.

在centos上使用curl命令的時候,我們也不是必須每次都輸入--cert,可以全域性新增ca信任即可.

我們開啟postman工具,新建一個標籤輸入我們要請求的地址,點選下面的Authorization,點選Type下拉選擇,選擇Bearer Token然後在右側的token選項裡輸入我們上一節獲取到的token,這時候就可以正常傳送請求了

img

把token儲存為全域性變數

我們可能經常要使用這個token來請求api,直接寫在頁面裡如果頁面關閉就會丟失掉,把它儲存到文字檔案每次都要貼上都不是很方便.其實在postman裡,我們可以把它儲存為一個變數,然後在需要使用的地方引用即可.

我們點選postman右上角齒輪圖示,彈出設定視窗介面

img

在出現的彈出介面裡選擇Globals,出現環境變數管理介面,在裡面輸入一個key(任意名稱,引用時要使用)和值.設定完成後點選save

img

我們把上面設定的Bearer token的token值改造一下,這裡引用剛才設定的apiservertoken,格式為{{key}}

img

如果key正確,滑鼠放在鍵上便會出現一個值預覽視窗.

當然,我們也可以把請求的基地址儲存為變數.改造後如下

img

快捷請求

我們從上面截圖可以看到,請求基地址會把所有的頂級api都返回,在postman裡,可以直接在響應的body裡點選這些api的名稱,postman會開啟一個新的視窗來請求它.比如我點選api/v1便會出現一個新的請求介面.我們點選下面的authorization然後選擇bearer token後面會自動把設定的token帶出來

img

我們可以點選send傳送一次請求.

postman針對大body佈局優化.

有些api返回的json數量量比較大,但是body視窗比較小.我們可以通過調整佈局來增加body空格的高度,以更方便檢視.

我們點選上面的view選單,選擇toggle tow-panel view(快捷鍵ctrl+alt+v),這樣body視窗就會變得高一些.當然針對特別巨大的json這樣也往往無能為力,這就需要藉助其它工具.大家可以使用自己喜歡的json檢視工具或者嘗試前面推薦的兩款.

相關文章