Inhoud

Inleiding

Voorwaarden

Vereisten

Gebruikte componenten

AccessOnboard API-documentatie

API’s testen met de Documentatietool

Gerelateerde informatie

Inleiding

In dit document wordt beschreven hoe de REST API-oproepen naar vManager kunnen worden gevalideerd en geconfigureerd door gebruik te maken van on-board documentatie.

Voorwaarden

Vereisten

Er zijn geen specifieke vereisten van toepassing op dit document.

Gebruikte componenten

Dit document is niet beperkt tot specifieke softwareversies of implementatietypen van vManager.

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Toegang tot on-board API-documentatie

De documentatie van vManager onboard API vindt u op de URL https://<vmanagement_ip>:<port:>/apidocs.  Deze documentatie toont API's die beschikbaar zijn op de huidige softwareversie.

Hiervoor is aanmelding met geldige vManager-referenties vereist.  Hoewel meerdere voorrechten documentatie kunnen weergeven, kan alleen een netadmin-gebruiker ze allemaal uitvoeren.

Opmerking: de API-documentatiepagina is beschikbaar voor huurders in een omgeving met meerdere huurders, maar bepaalde opdrachten zijn beperkt tot de provider.

vManager toont vervolgens een lijst met categorieën van beschikbare API's.  Klik op de gewenste categorie, gevolgd door de API-aanroep zelf, waarin deze velden worden weergegeven:

Beschrijving/implementatieopmerkingen

Beschrijving van de uitgevoerde handeling.

Parameters

Vereiste parameters die moeten worden opgegeven voor de API-aanroep.

Tekst aanvragen (POST/PUT/DELETE)

Formaat van de aanvragende instantie.

Antwoorden

Mogelijke reacties die door vManager naar de API worden verzonden.  Dit omvat HTTP-statuscode, reden en het mogelijke antwoordorgaan.

Uitbreidingen

Geldige extensies voor de oproep.

API’s testen met de Documentatietool

Beschikbare API's kunnen worden getest via de optie Try It Out.

Opmerking: let op dat dit geen simulatie is. De oproep wordt daadwerkelijk uitgevoerd op de lokale versie van vManager.  Plan dienovereenkomstig voor eventuele bijbehorende effecten.

1. Klik op de knop Try It Out.

2. Voer alle vereiste parameters in.

3. Klik op Uitvoeren.

Deze opdracht voert de API-taak uit en retourneert de van vManager ontvangen respons, die deze velden omvat:

URL aanvragen

De volledige gebruikte URL, inclusief het vManager-adres en de ingevoerde parameters.  Dit kan worden gebruikt door toepasbare scripts of hulpprogramma's die met succes sessies hebben geverifieerd.

Respons Body

De volledige antwoordgegevens werden ontvangen.

Antwoordcode

De HTTP status code is ontvangen.

Antwoordkoppen

Gebruikte koppen.

Gerelateerde informatie

Cisco Developer vManager API-documentatie