3.6.1. 编码操作资源输入参数

如果“rpc”或“action”语句具有“input”部分，那么这些输入参数的实例将在定义了“rpc”或“action”语句的模块名称空间中，在名为XML的元素或JSON对象中对“input”进行编码，它位于定义“rpc”或“action”语句的模块名称空间中。

如果“rpc”或“action”语句有一个“input”部分，并且“input”对象树包含任何被认为是强制节点的子数据节点，则消息体必须由客户端在请求中发送。

如果“rpc”或“action”语句具有“input”部分并且“input”对象树不包含任何被认为是强制节点的子节点，则客户端可以在请求中发送消息体。

如果“rpc”或“action”语句没有“input”部分，请求消息必须不包含消息体。

例子：

下面的YANG模块用于本节中的RPC操作示例。

  1. module example-ops {
  2.   namespace "https://example.com/ns/example-ops";
  3.   prefix "ops";
  5.   organization "Example, Inc.";
  6.   contact "support at example.com";
  7.   description "Example Operations Data Model Module.";
  8.   revision "2016-07-07" {
  9.     description "Initial version.";
  10.     reference "example.com document 3-3373.";
  11.   }
  13.   rpc reboot {
  14.     description "Reboot operation.";
  15.     input {
  16.       leaf delay {
  17.         type uint32;
  18.         units "seconds";
  19.         default 0;
  20.         description
  21.           "Number of seconds to wait before initiating the
  22.            reboot operation.";
  23.       }
  24.       leaf message {
  25.         type string;
  26.         description
  27.           "Log message to display when reboot is started.";
  28.       }
  29.       leaf language {
  30.         type string;
  31.         description "Language identifier string.";
  32.         reference "RFC 5646.";
  33.       }
  34.     }
  35.   }
  37.   rpc get-reboot-info {
  38.     description
  39.       "Retrieve parameters used in the last reboot operation.";
  40.     output {
  41.       leaf reboot-time {
  42.         type uint32;
  43.         description
  44.           "The 'delay' parameter used in the last reboot
  45.            operation.";
  46.       }
  47.       leaf message {
  48.         type string;
  49.         description
  50.           "The 'message' parameter used in the last reboot
  51.            operation.";
  52.       }
  53.       leaf language {
  54.         type string;
  55.         description
  56.           "The 'language' parameter used in the last reboot
  57.            operation.";
  58.       }
  59.     }
  60.   }
  61. }

以下的YANG模块用于本节的YANG动作示例。

  1. module example-actions {
  2.   yang-version 1.1;
  3.   namespace "https://example.com/ns/example-actions";
  4.   prefix "act";
  5.   import ietf-yang-types { prefix yang; }
  7.   organization "Example, Inc.";
  8.   contact "support at example.com";
  9.   description "Example Actions Data Model Module.";
  10.   revision "2016-07-07" {
  11.     description "Initial version.";
  12.     reference "example.com document 2-9973.";
  13.   }
  15.   container interfaces {
  16.     description "System interfaces.";
  17.     list interface {
  18.       key name;
  19.       description "One interface entry.";
  20.       leaf name {
  21.         type string;
  22.         description "Interface name.";
  23.       }
  25.       action reset {
  26.         description "Reset an interface.";
  27.         input {
  28.           leaf delay {
  29.             type uint32;
  30.             units "seconds";
  31.             default 0;
  32.             description
  33.               "Number of seconds to wait before starting the
  34.                interface reset.";
  35.           }
  36.         }
  37.       }
  39.       action get-last-reset-time {
  40.         description
  41.           "Retrieve the last interface reset time.";
  42.         output {
  43.           leaf last-reset {
  44.             type yang:date-and-time;
  45.             mandatory true;
  46.             description
  47.               "Date and time of the last interface reset, or
  48.                the last reboot time of the device.";
  49.           }
  50.         }
  51.       }
  52.     }
  53.   }
  55. }

RPC输入示例：

客户端可能会发送以下POST请求消息来调用“reboot”这个RPC操作：

  1. POST /restconf/operations/example-ops:reboot HTTP/1.1
  2. Host: example.com
  3. Content-Type: application/yang-data+xml
  5. <input xmlns="https://example.com/ns/example-ops">
  6.  <delay>600</delay>
  7.  <message>Going down for system maintenance</message>
  8.  <language>en-US</language>
  9. </input>

服务器可能会如下回应：

  1. HTTP/1.1 204 No Content
  2. Date: Thu, 26 Jan 2017 20:56:30 GMT
  3. Server: example-server

这里使用JSON编码显示了相同的示例请求消息：

  1. POST /restconf/operations/example-ops:reboot HTTP/1.1
  2. Host: example.com
  3. Content-Type: application/yang-data+json
  5. {
  6.   "example-ops:input" : {
  7.     "delay" : 600,
  8.     "message" : "Going down for system maintenance",
  9.     "language" : "en-US"
  10.   }
  11. }

操作输入示例：

客户端可能会发送以下POST请求消息来调用“reset”操作：

  1. POST /restconf/data/example-actions:interfaces/\
  2.    interface=eth0/reset HTTP/1.1
  3. Host: example.com
  4. Content-Type: application/yang-data+xml
  6. <input xmlns="https://example.com/ns/example-actions">
  7.   <delay>600</delay>
  8. </input>

服务器可能会如下回应：

  1. HTTP/1.1 204 No Content
  2. Date: Thu, 26 Jan 2017 20:56:30 GMT
  3. Server: example-server

这里使用JSON编码显示了相同的示例请求消息：

  1. POST /restconf/data/example-actions:interfaces/\
  2.   interface=eth0/reset HTTP/1.1
  3. Host: example.com
  4. Content-Type: application/yang-data+json
  6. { "example-actions:input" : {
  7.     "delay" : 600
  8.   }
  9. }