Cisco UCS Director REST 開発者ガイド、リリース 5.2
その他 REST API リソース
その他 REST API リソース

その他 REST API リソース

この章は、次の内容で構成されています。

XML または Java を使用した API 要求コードの作成およびテスト

はじめる前に

この手順を使用するには、[開発者メニューの有効化] オプションが選択されており、かつ [REST APIブラウザ] タブに移動してタスクのリストを表示している必要があります。 この項で前述した REST API ブラウザにアクセスする手順を参照してください。

3 つのタブがあるウィンドウが表示され、[APIの例] タブが開き、タスクの選択に対応したいくつかの API データが表示されます。 HTTP メソッドと URL 情報が表示されるはずです。

手順
    ステップ 1   タスク フォルダを開いて API 情報を表示してから、関心のある API リソースと操作を含む行をダブルクリックします。 操作およびリソースが新規 API 要求の作成をサポートしている場合には、[APIの例] タブにパラメータ値を入力するためのデータ入力ボックスが表示され、これを使用して適切な要求を作成できます。 データ入力ボックスが表示されない場合には、この手順に従ってデータを入力して新規 API 要求を作成することはできません。 [APIの例] タブに選択に対応した API データとその確認が表示され、かつ HTTP メソッドと URL 情報が表示された場合には、提供されたデータを使用することができます。
    ステップ 2   データ入力ボックスに [選択...] が表示された場合には、それをクリックするとデータ検索フィルタが開きます。フィルタを使用してデータを絞り込み、入力の必要があるデータを選択することができます。
    ステップ 3   必要に応じて、[APIの例] タブで不足データ(API 要求パラメータ)を表示し、新規 API 要求を定義します。 パラメータに関する有用な情報については、[詳細] タブを参照してください。
    1. [XMLの生成] をクリックして要求のサンプルを確認することができます。
    ステップ 4   API リソースおよび操作名の確認、および要求と応答データのデータ形式と定義を確認するには、[詳細] タブを開きます。
    ステップ 5   REST API ブラウザで API を実行するには、[詳細] タブをクリックしてから、[送信] をクリックします。
    重要: また、[APIの例] タブおよび [サンプル Java コード] タブを使用して API の例とサンプル Java コードを送信することもできます。
    ステップ 6   REST API 要求コードに相当する Java コードを確認するには、[サンプル Java コード] タブを開きます。

    次の作業

    成功した有用な API 要求の送信に使用されたコードのコピーを保存しておき、必要に応じてアプリケーションで使用します。

    カスタム タスクのインポート

    手順
      ステップ 1   カスタム タスクの .wfdx ファイルをエンコードして、エンコード済みスクリプトにします。 例として、HostandVMPerf.wfdx ファイルを挙げることができます。

      .wfdx ファイルをエンコードするには、以下の手順を実行します。

      1. テキスト エディタまたはメモ帳で .wfdx ファイルを開きます。
      2. .wfdx ファイルの内容をコピーして、URL Encoder/​Decoder にある、エンコードまたはデコードするテキスト用のテキスト ボックスに貼り付けます。
      3. ドロップダウン リストから、[UTF-8] を選択します。
      4. [URL エンコード] をクリックします。 XML が RESTClient アドオン経由で渡すために必要な形式にエンコードされます。
      ステップ 2   Mozilla Firefox ブラウザで RESTClient アドオンを呼び出します。
      ステップ 3   [メソッド] ドロップダウン リストから、[POST] を選択します。
      ステップ 4   [URL] フィールドに、サーバの URL を入力します。

      サーバの URL の形式は、http://<サーバの IP アドレス>/cloupia/api-v2/customtaskImport です。

      ステップ 5   API 要求ヘッダーに必要なサーバの REST API アクセス キーを入力します。

      API アクセス キーの取得手順については、API アクセス キーの生成を参照してください。

      ステップ 6   [本文] フィールドにエンコード済みスクリプトを貼り付けます。
      ステップ 7   エンコード済みスクリプトの先頭に次のタグを追加します。
      <cuicOperationRequest>
      <operationType>CREATE</operationType>
      <payload>
      <![CDATA[
      <customtaskImport>
                             
      <importText>  ---------- encoded text-------
       
      ステップ 8   エンコード済みスクリプトの末尾に次のタグを追加します。
      </importText>
        </customtaskImport>
       ]]>
      </payload>
      </cuicOperationRequest>
       
      ステップ 9   [送信] をクリックします。
      ステップ 10   [応答ヘッダー] タブと [応答本文(未加工)] タブをクリックして、応答ヘッダーと本文を確認します。

      インポートしたカスタム タスクが Cisco UCS Director に表示されます。 ホスト名または IP アドレスで Cisco UCS Director にログインして、[ポリシー] > [オーケストレーション] の順に選択します。 [カスタム ワークフロー タスク] タブをクリックします。 インポートしたカスタム タスクが [カスタム ワークフロー タスク] 表に表示され、ワークフローで使用可能になります。