使用 Swagger 使用者介面

您可以在登入並授權之後立即在 Swagger 使用者介面中進行 API 呼叫。 您可以使用 Swagger 使用者介面來使用 可能原因 API ,並使用 度量異常偵測 API來擷取度量資料。 請完成下列步驟,以在 Swagger 使用者介面上授權。

關於此作業

您可以在登入並授權之後立即在 Swagger 使用者介面中進行 API 呼叫。 請完成下列步驟,以在 Swagger 使用者介面上授權。 此介面記錄有 Swagger (http://swagger.io) 和 Swagger 使用者介面 (https://swagger.io/swagger-ui/)

程序

  1. 產生 API 金鑰:
    1. 開啟 Netcool® Operations Insight® 使用者介面,然後按一下 事件管理 管理 頁面上的 API 金鑰
    2. 按一下 新建 API 金鑰
    3. API 金鑰說明中輸入金鑰的說明。
    4. 指定金鑰提供存取權之 事件管理 API 的哪一部分。 移至 許可權 ,並確保只選取您要金鑰提供存取權的那些勾選框。 依預設會選取所有 API。 清除您不想要 API 金鑰提供存取權的項目。
      重要事項:請記下金鑰提供存取權的 API。 例如,在您為金鑰輸入的說明中進行記錄。 您稍後無法檢視或變更為金鑰選取的 API。
    5. 按一下 產生。 即會產生新的名稱和密碼。 請記下這些值。
      重要事項:依預設,會隱藏密碼。 若要檢視並且複製密碼,請將顯示密碼設為顯示。 請務必記下密碼。 基於安全理由,稍後無法擷取密碼。 如果遺失密碼,您必須刪除 API 金鑰,然後產生新的 API 金鑰。
    6. 按一下 管理 API 金鑰 旁邊的圖示,以檢視 API 的基本 URL。
  2. 使用您產生的 API 金鑰來登入 Swagger。 從 Swagger 標頭區段中,按一下 授權 ,並在登入對話框中輸入 API 金鑰名稱和 API 金鑰密碼,然後再次按一下 授權
  3. 閱讀 Swagger 使用者介面上可用的可能動作,並選擇您要執行的動作。
  4. 遵循 Swagger 使用者介面上呈現的 API 文件來配置您要執行的 API 動作。
  5. 執行動作並檢查產生的回應碼。