concept_api_before_browser.adoc

sidebar	permalink	keywords	summary
sidebar	concept_api_before_browser.html	rest api, deploy rest api, rest, access browser, before you begin	在使用「部署」線上文件頁面之前、您應該瞭解幾項事項。

使用瀏覽器存取API之前

在使用「部署」線上文件頁面之前、您應該瞭解幾項事項。

部署計畫

如果您打算在執行特定部署或管理工作時發出API呼叫、則應考慮建立部署計畫。這些計畫可以是正式或非正式的、通常包含您的目標和要使用的API呼叫。如需詳細資訊、請參閱使用部署REST API的工作流程程序。

Json範例和參數定義

每個API呼叫都會以一致的格式在文件頁面中說明。內容包括實作附註、查詢參數及HTTP狀態代碼。此外、您也可以顯示API要求和回應所使用的Json詳細資料、如下所示：

• 範例值
  如果您在 API 呼叫上按一下 example. value 、則會顯示通話的典型 JSON 結構。您可以視需要修改範例、並將其做為申請的輸入。

• 模型
  如果您按一下 Model 、就會顯示完整的 JSON 參數清單、並提供每個參數的說明。

發出API呼叫時的注意事項

您使用「部署」文件頁面執行的所有API作業都是即時作業。您應小心不要錯誤地建立、更新或刪除組態或其他資料。