REST API の表示

オンライン編集

クラスタ管理者は、 Red Hat® OpenShift® Container Platform （OCP）コンソールを使用して、 WebSphere Automation REST APIでSwagger UI URL を決定することができます。

手順

  1. OpenShift Container Platform 、コンソールで Networking > Routesをクリックする。
  2. Swagger UI にアクセスするには、ご使用のバージョンの WebSphere Automationの手順に従ってください。
    • WebSphere Automation 1.4.3 以降の場合:
      1. 「経路」 ページで、 cpd 項目を見つけます。
      2. 「Location」列の URLをコピーします。
      3. 新しいブラウザー・タブまたはウィンドウを開きます。
      4. 手順3でコピーした URL をブラウザのアドレス欄に貼り付け、 URLに以下のいずれかのパスを追加して、Enterキーを押します。
        • Core API の場合は、以下のパスを追加します。
          /websphereauto/core/apis/openapi/ui/
        • Health API の場合は、以下のパスを追加します。
          /websphereauto/health/apis/openapi/ui/
        • セキュリティー API の場合は、以下のパスを追加します。
          /websphereauto/secvul/apis/openapi/ui/
    • WebSphere Automation 1.4.2 以前の場合:
      1. 「経路」 ページで、以下のいずれかの項目を見つけます。
        • セキュリティーの場合: wsa-secure-apis
        • 正常性の場合: wsa-healing-rest
      2. 「ロケーション」 列の URL をクリックします。

        この URL で、ブランクのブラウザー・ウィンドウが開きます。

      3. ブラウザーのアドレス・フィールドをクリックし、既存の URL に /openapi/ui を付加し、Enter キーを押します。
    ブラウザー・ウィンドウで Swagger UI が開きます。
  3. 「許可」をクリックします。
    「使用可能な許可 (Available authorizations)」ダイアログが開きます。
  4. 「 値 」テキスト・ボックスに、許可ユーザー・プロファイルのトークン値を入力します。
    トークンを取得するには:
    1. 管理者アカウントのパスワードを取得します。
      oc -n WSA_INSTANCE_NAMESPACE get secret ibm-iam-bindinfo-platform-auth-idp-credentials -o jsonpath='{.data.admin_password}' | base64 -d && echo

      WSA_INSTANCE_NAMESPACE は、 WebSphere Automation がインストールされているインスタンスの名前空間です。インストール時にデフォルト値が選択された場合、値は websphere-automationです。

    2. 以下のコマンドの <password> を、前のステップでコマンドから返された値に置き換え、 WSA_INSTANCE_NAMESPACEに正しい値を使用します。
      curl -k -X POST -H 'Content-Type: application/json' -d '{"username":"cpadmin","password":"<password>"}' https://$(oc get route -n WSA_INSTANCE_NAMESPACE -o jsonpath='{.items[?(@.spec.to.name=="ibm-nginx-svc")].spec.host}')/icp4d-api/v1/authorize | jq -r .token
    詳しくは、クラスター管理者にお問い合わせください。

結果

有効なトークンを使用して正常に許可した後、Swagger UI を使用して WebSphere Automation REST API を表示できます。