簡介
本文檔介紹如何使用板載文檔驗證和配置對vManage的REST API呼叫。
必要條件
需求
本文件沒有特定需求。
採用元件
本文檔不限於特定軟體版本或vManage部署型別。
本文中的資訊是根據特定實驗室環境內的裝置所建立。文中使用到的所有裝置皆從已清除（預設）的組態來啟動。如果您的網路運作中，請確保您瞭解任何指令可能造成的影響。
訪問板載API文檔
vManage onboard API文檔位於URL https://<vmanage_ip>:<port:>/apidocs。 本文檔顯示當前軟體版本上可用的API。
這需要使用有效的vManage憑據登入。 雖然多個許可權級別可以檢視文檔，但只有netadmin使用者能夠執行所有許可權。
注意:API文檔頁面對多租戶環境中的租戶可用，但某些命令僅限於提供商使用。
vManage則顯示可用API類別的清單。 按一下所需的類別，然後點選API呼叫本身，顯示以下欄位：
| 說明/實施說明 |
所執行操作的描述。 |
| 引數 |
要為API呼叫指定的必需引數。 |
| 請求正文(POST/PUT/DELETE) |
請求正文的格式。 |
| 響應 |
vManage傳送到API的可能響應。包括HTTP狀態代碼、原因和可能的響應正文。 |
| 延伸 |
呼叫的有效分機。 |
從文檔工具測試API
可用API可通過Try It Out選項進行測試。
註：請注意，這不是模擬。該呼叫實際上是在本地vManage上執行的。 相應地規劃任何相關影響。
- 按一下「Try It Out」按鈕。
- 輸入所有必需的引數。
- 按一下「Execute」。
此命令執行API任務，並返回從vManage接收的響應，包括以下欄位：
| 請求URL |
使用的完整URL，包括vManage地址和輸入的任何引數。 成功通過會話驗證的適用指令碼或實用程式可以使用此功能。 |
| 響應正文 |
收到的完整響應資料。 |
| 響應代碼 |
收到HTTP狀態代碼。 |
| 響應報頭 |
已使用標頭。 |
相關資訊
Cisco Developer vManage API文檔
意見