目录

简介

先决条件

要求

使用的组件

AccessOnboard API文档

从文档工具测试API

相关信息

简介

本文档介绍如何使用板载文档验证和配置对vManage的REST API调用。

先决条件

要求

本文档没有任何特定的要求。

使用的组件

本文档不限于特定软件版本或vManage部署类型。

本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始（默认）配置。如果您的网络处于活动状态，请确保您了解所有命令的潜在影响。

访问板载API文档

vManage onboard API文档位于URL https://<vmanage_ip>:<port:>/apidocs。  本文档显示当前软件版本上可用的API。

这要求使用有效的vManage凭证登录。  虽然多个权限级别可以查看文档，但只有netadmin用户能够执行所有权限级别。

注意:API文档页面可用于多租户环境中的租户，但某些命令仅限于提供商使用。

vManage然后显示可用API类别的列表。  点击所需的类别，然后点击API调用本身，将显示以下字段：

说明/实施说明

所执行操作的说明。

参数

为API调用指定所需的参数。

请求正文(POST/PUT/DELETE)

请求正文的格式。

响应

vManage发送到API的可能响应。包括HTTP状态代码、原因和可能的响应正文。

分机

呼叫的有效分机。

从文档工具测试API

可以通过Try It Out选项测试可用的API。

注：请注意，这不是模拟。该调用实际上是在本地vManage上执行的。  相应地规划任何相关影响。

1. 单击Try It Out按钮。

2. 输入所有必需的参数。

3. 单击Execute。

此命令执行API任务，并返回从vManage接收的响应，包括以下字段：

请求URL

使用的完整URL，包括vManage地址和输入的任何参数。  成功通过会话身份验证的适用脚本或实用程序可以使用此功能。

响应正文

收到的完整响应数据。

响应代码

收到的HTTP状态代码。

响应报头

使用的信头。

相关信息

思科开发人员vManage API文档