許多 REST 及指令行用戶端指令都會在其說明主題中提供範例。這裡提供了使用各種程式設計語言的更多範例及實務範例。用於伺服器與用於藍圖設計伺服器的指令很相似。
完整實務範例
如需同時使用數個 REST 指令的完整範例,請參閱下列頁面:
在處理程序步驟中執行 REST 指令
外掛程式包含許多與 REST API 指令執行相同作業的步驟,但如果您想要在處理程序期間執行 REST 指令,其中一種方式是使用「Web 公用程式」外掛程式中的「傳送 HTTP 呼叫」步驟。如果要將 REST API 與此步驟搭配使用,請將該步驟新增至程序並指定下列資訊:
- 名稱
- 指定步驟的名稱。
- URL
- 指定指令的完整 URL。比方說,如果要使用指令 Get information about all applications on the server,請使用 ucd-server.example.com 之伺服器的主機名稱或 IP 位址來指定 URL https://ucd-server.example.com:8443/cli/application。
- HTTP 方法
- 指定指令的方法,例如 GET 或 PUT。如需要使用的方法,請參閱指令的說明文件。
- 標頭
- 指定指令的任何標頭,以換行區隔。如果指令需要標頭,則標頭會列出在指令的說明文件中。 比方說,如果您要一起傳送 JSON 資料及指令,請新增下列標頭:
Content-Type: application/json
步驟即會自動包括標頭 Content-Length、Content-Type、Accept 及 Connection。您可以透過在標頭欄位中指定這些標頭來置換每一個標頭(Content-Length 標頭除外)。Accept 及 Content-Type 標頭由「要求內容類型」欄位中的值來設定,但您仍然可以在標頭欄位中置換這些標頭。
- 資料/資料檔案
- 指定要與指令一起傳送的資料有效負載或包含資料的檔案。
- 要求內容類型
- 選取資料的內容類型。此欄位會設定 Accept 及 Content-Type 標頭的值。
- 容許未授信的 SSL 憑證
- 選取這個勾選框會忽略未授信的憑證,例如自簽憑證。
- 使用者名稱
- 指定用來執行指令的使用者名稱。搭配執行指令與 REST API 所需的許可權與使用 Web 介面時所需的許可權相同。
- 密碼
- 指定用來執行指令的密碼。
- 輸出檔
- 選擇性地指定用來儲存指令結果的檔名。
在指令行介面中執行 REST 指令
Linux 程式 curl 是可以從指令行執行 REST 指令的眾多程式之一。如需範例,請參閱執行 REST 指令。