思科MeetingServer基本API函数.pdf

思科 Meeting Server 基本 API 函数 Contents Introduction Prerequisites Requirements Components Used 背景信息 API 请求和响应 Configure HTTP POST HTTP GET HTTP PUT HTTP DELETE API 客户端 POSTER POSTMAN Verify Troubleshoot Introduction 本文档介绍 CMS（思科 Meeting Server）上使用的四个基本 API（应用接口）函数 GET、POST、 PUT 和 DELETE。此外，还介绍了两个不同的 API 工具：Poster 和 Postman，以及如何使用这两 个工具配置 CMS。 提供者：Vernon Depee，思科技术支持中心 (TAC) 工程师。 Prerequisites Requirements There are no specific requirements for this document. Components Used This document is not restricted to specific software and hardware versions. 本文档中的信息可以结合 Postman 或 Poster 等不同的 API 客户端使用。本文档的 API 客户端部分 中介绍了这两个工具。  The information in this document was created from the devices in a specific lab environment.All of the devices used in this document started with a cleared (default) configuration.If your network is live, make sure that you understand the potential impact of any command. 背景信息 CMS 的 API 是配置其多项功能的极其灵活的方式。本文中回顾或介绍了大量 API 功能，请务必参 考当前的 API 参考文档。截止撰写本文时，当前的 API 参考指南在此处提供 API 请求和响应 API 通信是客户端和服务器之间的请求响应关系。客户端向服务器发出请求。处理请求（完成操作 ，或拒绝执行此操作）后，返回响应。 本文中所述的请求为以下四个： 1. GET -检索现有信息 2. POST - 创建新信息 3. PUT -修改现有信息 4. DELETE -删除现有信息。 以下是用于配置 CMS 的基本 API 请求。 最常见的响应为 200 OK，包括 4xx 和 5xx 在内的其他的响应为错误响应。 Configure 我们通过配置示例说明这四个基本请求。 HTTP POST 第 1 步：使用 POST 创建对象。 在本示例中，使用此请求创建 CMS 空间。要通过 API 创建空间，请参阅 API 文档。针对本示例 ，我们使用的是此指南。 目录中说明第 6.2 部分介绍如何创建和修改 cospace。 第一句为，要创建空间，您需要向 /coSpaces 发送 post。后面接着说，空间 ID 位于 200 OK 的 “Location”标头中。太好了，您现在知道如何创建空间了。您只需向 https://WebAdminIP/api/v1/coSpaces发送 POST。 指定 POST 的参数。 您会在文档的第 6.2 部分看到一个表，其中列出了您可以使用的所有参数。 例如：使用名称 APITest 并在 URI 的用户部分使用 APITestURI 来创建空间 内容类型为 application/x-www-form-urlencoded ，内容为 name=APITesturi=APITestURI 添加此参数后即完成请求，如下图所示。 POST https://WebAdminIP/api/v1/coSpaces HTTP/1.1 Host: WebAdminIP Content-Type: application/x-www-form-urlencoded Content-Length: 27 Authorization: Basic YWRtaW46QzFzYzBDMXNjMA== Connection: keep-alive name=APITesturi=APITe