API Guide

Identifier GUID-3DAD08FE-0B97-4B2C-81BD-84CDE89BEB9B
Version 4
Status Translation approved
RESTCONF API
RESTCONF 是使用 HTTPS 连接的表述性状态传输 (REST)。通过 OS10 RESTCONF API 在 OS10 交换机上使用 JavaScript Object
Notation (JSON) 结构化消息来设置配置参数。使用任何编程语言创建并发送 JSON 消息。本章中的示例使用 curl。
OS10 RESTCONF 实施符合 RFC 8040。您可以使用 RESTCONF API 来配置和监控 OS10 交换机。
OS10 RESTCONF API 将 HTTP 与端口 443 上的传输层安全 (TLS) 议配合使用。OS10 支持 RFC 7230 中定义的 HTTP/1.1 传输。
RESTCONF API 使用基于可插拔身份验证模块 (PAM) 的身份验证。
在受支持的平台上，默认情况下，OS10 RESTCONF API 处于禁用状态。要配置和启用 RESTCONF API，请参阅 配置 RESTCONF API
部分。
要配置和监控 OS10 交换机，请使用 REST API 客户端工具（如 Postman 或 Swagger）来执行 web 请求。REST API 请求（例如
GET、PUT、POST、DELETE 和 PATCH）在 OS10 RESTCONF 资源上运行，例如：
表. 105: OS10 RESTCONF 资源
资源 说明
URL
数据
RESTCONF API 客户端访问的配置和操作数据 /restconf/data
操作
协议特定数据模型操作的容器 OS10 通告 /restconf/operations
要浏览 OS10 RESTCONF API 端点和操作，请参阅 Dell EMC 支持站点的 OS10 Enterprise Edition 软件页面上提供的 OpenAPI JSON 文
件。下载 JSON 文件并将其导入到 REST API 客户端工具；例如，Swagger 或 Postman，以生成代码、文档和测试案例。有关
OpenAPI 规格的信息，请转至 https://swagger.io/docs/specification/about/。
Identifier
GUID-352FAAB1-BDE6-4D00-AC89-CBA151BCF36A
Version 3
Status Translation approved
配置 RESTCONF API
要在 OS10 接口上使用 RESTCONF API，必须使用 rest api restconf 命令启用 RESTCONF API 服务。您还可以配置 HTTPS 访
问，包括：
• 安全套接字层 (SSL) 自签名服务器证书中需要的主机名称
• HTTPS 连接超时
• 用于加密 HTTPS 连接中的数据的加密套件
启用 RESTCONF API 之后，您可以从远程设备发送 HTTPS 请求。
1. （可选）使用最多 30 个字母数字字符，在 CONFIGURATION 模式下的 RESTCONF HTTPS 连接中配置 SSL 自签名服务器证书所
需的主机名称。输入 OS10 交换机的 IP 地址或域名。默认情况下，OS10 交换机的域名用作主机名称。
rest https server-certificate name hostname
2. （可选）配置 RESTCONF HTTPS 会话在 CONFIGURATION 模式下使用的超时时间为 30 至 65535 秒；默认值为 30。
rest https session timeout seconds
3. （可选）限制交换机在 RESTCONF HTTPS 会话中使用的密码，以在 CONFIGURATION 模式中对数据进行加密和解密。默认情况
下，支持 OS10 上安装的所有加密套件。用空格分隔多个条目。有效的密码套件值为：
• dhe-rsa-with-aes-128-gcm-SHA256
• dhe-rsa-with-aes-256-gcm-SHA384
• ecdhe-rsa-with-aes-128-gcm-SHA256
27
RESTCONF API 1321