内容

概要

前提条件

要件

使用するコンポーネント

AccessOnboard APIドキュメント

ドキュメントツールからのAPIのテスト

関連情報

概要

このドキュメントでは、オンボードドキュメントを使用してvManageへのREST APIコールを検証および設定する方法について説明します。

前提条件

要件

このドキュメントに関する固有の要件はありません。

使用するコンポーネント

このドキュメントは、特定のソフトウェアバージョンやvManage導入タイプに限定されるものではありません。

このドキュメントの情報は、特定のラボ環境にあるデバイスに基づいて作成されました。このドキュメントで使用するすべてのデバイスは、クリアな（デフォルト）設定で作業を開始しています。本稼働中のネットワークでは、各コマンドによって起こる可能性がある影響を十分確認してください。

Onboard APIドキュメントへのアクセス

vManageオンボードAPIのドキュメントは、URL https://<vmanage_ip>:<port:>/apidocsにあります。  このドキュメントでは、現在のソフトウェアバージョンで使用可能なAPIを示します。

これには、有効なvManageクレデンシャルでログインする必要があります。  複数の特権レベルでドキュメントを表示できますが、すべてのドキュメントを実行できるのはnetadminユーザだけです。

注：マルチテナント環境のテナントは、APIドキュメントページを使用できますが、一部のコマンドはプロバイダーのみに制限されています。

vManageは、使用可能なAPIのカテゴリのリストを表示します。  目的のカテゴリをクリックし、続いてAPIコール自体をクリックすると、次のフィールドが表示されます。

説明/実装に関する注意事項

実行された操作の説明。

パラメータ

API呼び出しに指定する必要なパラメーターです。

リクエスト本文(POST/PUT/DELETE)

要求本文の形式です。

回答

vManageがAPIに送信する可能な応答。これには、HTTPステータスコード、理由、および可能な応答本文が含まれます。

拡張子

コールの有効な内線番号。

ドキュメントツールからのAPIのテスト

使用可能なAPIは、Try It Outオプションでテストできます。

注：これはシミュレーションではないことに注意してください。コールはローカルvManageで実際に実行されます。  それに応じて、関連する影響を計画します。

1. Try It Outボタンをクリックします。

2. 必要なパラメータをすべて入力します。

3. [Execute] をクリックします。

このコマンドはAPIタスクを実行し、vManageから受信した応答を返します。この応答には次のフィールドが含まれます。

要求URL

使用される完全なURL。vManageアドレスと入力されたパラメータが含まれます。  これは、セッションの認証に成功した適用可能なスクリプトまたはユーティリティで使用できます。

応答本文

受信した完全な応答データ。

応答コード

受信したHTTPステータスコード。

応答ヘッダー

使用するヘッダー。

関連情報

Cisco Developer vManage APIドキュメント