この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
Cisco APIC-EM コントローラは、インタラクティブな、ノースバウンド Representational State Transfer(REST)API ドキュメントを提供します。REST API ドキュメントを使用して、大規模なネットワーク管理システムとコントローラを統合し、ネットワークの管理に役立てることができます。
グローバル ツールバーからノースバウンド REST API ドキュメントにアクセスするには、[API] をクリックします。
(注) | REST API ドキュメントは、Swagger 1.2 仕様に基づいています。 |
インタラクティブなノースバウンド REST API ドキュメントでは、次の内容を提供します。
ノースバウンド REST API の利用規約および Cisco Developer Community の Web サイトに関する次の情報へのリンクは、次のとおりです。
コントローラによって使用され、アプリケーションによって構成された、サポートされているノースバウンド REST API に関するリストは、次のとおりです。
ファイル
フロー分析
IP 位置情報
IP プール マネージャ
インベントリ
ネットワーク ディスカバリ
ネットワーク プラグ アンド プレイ
PKI ブローカ サービス
ポリシー管理
ロール ベース アクセス コントロール
スケジューラ
タスク
トポロジ
可視性
(注) | アクティブなサービスが実行されているアプリケーションのみが、メニュー リストに表示されます。 |
それぞれのノースバウンド REST API でサポートされているメソッドのリストは、次のとおりです。
API のメソッドは、次のとおりです。
未処理(Raw)のコンテンツ:外部の Swagger UI(ユーザが用意)の未処理のコンテンツを提供して、ノースバウンド REST API にアクセスします。コンテンツはテキスト ファイル形式で提供されます。
ノースバウンド REST API に関する理解を深めるために、サンプルのメソッドを実行し、結果の出力を取得できます。詳細については、Cisco APIC-EM REST API ウィンドウの使用を参照してください。
次の表では、Cisco APIC-EM でサポートされる HTTPS メソッドおよび構造について説明します。
HTTPS メソッド タイプ |
Structure |
---|---|
GET |
Get メソッド タイプでは次の値を使用します。 |
POST |
複製リソース、または次の応答を送信した場合、POST メソッド タイプは、409 応答コードを返します。 {"response":"id-of-created-resource"} |
PUT |
PUT メソッド タイプは次の応答を返します。 {"response":"message-about-attributes-that-changed"} |
DELETE |
DELETE メソッド タイプは、失敗した場合 404 応答コード、または次の応答を返します。 {"response":"message-about-deletion"} |
外部 RESTful サービスは、以下で説明されている共通の HTTP 応答コードを返します。応答ヘッダーで返されるステータス コードに加えて、各応答には、要求の性質に応じて、(JSON 形式の)追加のコンテンツがある場合があります。
ステータス コード |
説明 |
---|---|
200 OK |
要求は成功しました。結果は応答本文に含まれています。 |
201 Created |
POST/PUT 要求が処理され、新しいリソースが作成されました。リソースに関する情報は、応答本文にあります。 |
202 Accepted |
要求が受け入れられて処理されましたが、処理が完了していません。 |
204 No Content |
要求は成功しましたが、コンテンツが戻りませんでした。 |
206 Partial Content |
GET 要求は範囲ヘッダーを含み、サーバは範囲に一致する部分的な内容を返しました。 |
ステータス コード |
説明 |
---|---|
400 Bad Request |
クライアントがサーバが理解できない要求をしました(例えば、要求構文が正しくない)。 |
401 Unauthorized |
要求に含まれるクライアントの認証クレデンシャルが欠落しているか、または無効です。 |
403 Forbidden |
サーバは認証クレデンシャルを認識しますが、クライアントはこの要求を実行するための承認がされていません。 |
404 Not Found |
クライアントは存在しないリソースに対して要求を行いました。 |
409 Conflict |
ターゲット リソースは競合状態です(例えば、複数のユーザによって編集されているリソースの編集の競合)。後で要求を再試行すると成功する場合があります。 |
415 Unsupported Media Type |
クライアントは、サーバがサポートしない形式の要求本文を送信しました(例えば、JSON だけを受け入れるサーバに対する XML)。 |
ステータス コード |
説明 |
---|---|
500 Internal Server Error |
サーバは要求を処理できませんでした。 |
501 Not Implemented |
サーバに要求を処理するための機能がありません。 |
503 Service Unavailable |
サービスは(一時的に)利用できません。 |
[API] ウィンドウで、Cisco APIC-EM ノースバウンド REST API をテストできます。
この API の追加のメソッドをテストするか、または新しい API とそのメソッドを試します。