API Guide

curl 命令
curl 命令选项包括：
• -X 可指定 HTTPS 请求类型；例如，POST、PATCH 或 GET。
• -u 可指定用户名和密码以用于服务器身份验证。
• -k 可指定文本文件以读取 curl 参数。文本文件中的命令行参数将以似乎在命令行中提供的方式使用。从远程编排系统访问 OS10
RESTCONF API 时，将使用 OS10 交换机的 IP 地址或 URL。
• 将 HTTPS 发送到服务器时，-H 可指定额外的标头以包括在请求中。您可以输入多个额外的标头。
• -d 将在 HTTPS 请求中发送指定的数据。
在 curl 命令中，使用 %2F 以代表反斜杠 (/)；例如，输入 ethernet1/2/3 作为 ethernet1%2F1%2F3。
有关详细信息，请参阅 curl Man 页面。
使用情况信息
使用 curl 命令访问 OS10 RESTCONF API 时，请考虑以下情况：
• Dell EMC 建议使用目标资源的指定 UR，以用于扩展系统中的 GET 查询。例如，curl -X GET -k -u admin:admin -H
"accept:application/json" https://$TARGET/restconf/data/interfaces/interface/port-channel10
OS10 在 RESTCONF 数据库的根资源上不支持 REST 查询。例如，GET 查询 curl -X GET -k -u admin:admin https://
$TARGET/restconf/data 将返回错误。
• 当 RESTCONF 查询正在进行时，您无法配置任何 CLI 命令，直到 RESTCONF 查询完成。
• 建议使用 POST 请求，而不是 PUT，以替换目标数据资源。
Identifier
GUID-B368F2D1-1B36-4D6C-AEE4-7BD0F7754E81
Version 2
Status Translation approved
查看 CLI 命令的 XML 结构
要使用 RESTCONF API 配置和监控 OS10 交换机，请使用 JSON 格式的数据参数创建 HTTPS 请求。JSON 数据参数与 OS10 命令的
XML 结构中的参数相同。
要在 OS10 命令的 XML 代码中显示参数值作为参考，请在 EXEC 模式下使用 debug cli netconf 命令。在 CONFIGURATION 模
式中，使用 do debug cli netconf 命令。
此命令可启用 CLI 到 XML 显示。在提示符下，输入 XML 请求的 OS10 命令和所需的回复。要退出 CLI 到 XML 显示，请使用 no
debug cli netconf 命令。
找到适用于相同 JSON 数据参数的 XML 参数值。例如，要在 OS10 交换机上配置 VLAN 20，请在卷曲命令中输入 RESTCONF 端点和
JSON 内容。请注意，JSON type 和 name 参数显示在 interface vlan 命令的 XML 结构中。
• RESTCONF 端点：/restconf/data/interfaces
• JSON 数据内容：
{
"interface": [{
"type": "iana-if-type:l2vlan",
"enabled": true,
“description”: “vlan20”,
"name": "vlan20"
}]
}
1324 RESTCONF API