Inhalt

Einleitung

Voraussetzungen

Anforderungen

Verwendete Komponenten

AccessOnboard API-Dokumentation

Test-APIs aus dem Dokumentationstool

Zugehörige Informationen

Einleitung

In diesem Dokument wird beschrieben, wie REST-API-Aufrufe für vManage mithilfe der integrierten Dokumentation validiert und konfiguriert werden.

Voraussetzungen

Anforderungen

Es gibt keine spezifischen Anforderungen für dieses Dokument.

Verwendete Komponenten

Dieses Dokument ist nicht auf bestimmte Softwareversionen oder vManage-Bereitstellungstypen beschränkt.

Die Informationen in diesem Dokument beziehen sich auf Geräte in einer speziell eingerichteten Testumgebung. Alle Geräte, die in diesem Dokument benutzt wurden, begannen mit einer gelöschten (Nichterfüllungs) Konfiguration. Wenn Ihr Netzwerk in Betrieb ist, stellen Sie sicher, dass Sie die möglichen Auswirkungen aller Befehle kennen.

Zugriff auf integrierte API-Dokumentation

Die Dokumentation zur integrierten vManage API finden Sie unter der URL https://<vmanage_ip>:<port:>/apidocs.  In dieser Dokumentation werden die für die aktuelle Softwareversion verfügbaren APIs angezeigt.

Dies erfordert die Anmeldung mit gültigen vManage-Anmeldeinformationen.  Obwohl mehrere Berechtigungsebenen Dokumentation anzeigen können, kann nur ein netadmin-Benutzer sie alle ausführen.

Hinweis: Die API-Dokumentationsseite steht Tenants in einer Multi-Tenant-Umgebung zur Verfügung. Bestimmte Befehle sind jedoch auf den Anbieter beschränkt.

vManage zeigt dann eine Liste mit Kategorien verfügbarer APIs an.  Klicken Sie auf die gewünschte Kategorie, gefolgt vom API-Aufruf selbst. Daraufhin werden folgende Felder angezeigt:

Beschreibung/Implementierungshinweise

Beschreibung des ausgeführten Vorgangs.

Parameter

Erforderliche Parameter, die für den API-Aufruf angegeben werden müssen.

Request Body (POST/PUT/DELETE)

Format des Anforderungstexts.

Antworten

Mögliche Antworten, die vManage an die API sendet.  Dazu gehören HTTP-Statuscode, Grund und der mögliche Antworttext.

Erweiterungen

Gültige Durchwahlen für den Anruf.

Test-APIs aus dem Dokumentationstool

Verfügbare APIs können über die Try It Out-Option getestet werden.

Hinweis: Beachten Sie, dass es sich nicht um eine Simulation handelt. Der Aufruf wird auf dem lokalen vManage ausgeführt.  Planen Sie die damit verbundenen Auswirkungen entsprechend ein.

1. Klicken Sie auf die Schaltfläche "Try It Out".

2. Geben Sie alle erforderlichen Parameter ein.

3. Klicken Sie auf Ausführen.

Dieser Befehl führt die API-Aufgabe aus und gibt die von vManage empfangene Antwort zurück, die folgende Felder enthält:

URL anfordern

Die verwendete vollständige URL, die die vManage-Adresse und alle eingegebenen Parameter enthält.  Dies kann von entsprechenden Skripten oder Dienstprogrammen verwendet werden, die Sitzungen erfolgreich authentifiziert haben.

Antworttext

Die empfangenen vollständigen Antwortdaten.

Antwortcode

Der empfangene HTTP-Statuscode.

Antwort-Header

Verwendete Header.

Zugehörige Informationen

Dokumentation für Cisco Developer vManage API