1.1.5. 条款

本文件中使用以下术语：

  • API资源：RESTCONF根资源的模型资源和访问YANG定义的内容的子资源。它是在“ietf-restconf”模块中用名为“yang-api”的YANG数据模板定义的。

  • 客户端：RESTCONF客户端。

  • 数据资源：模拟YANG数据节点的资源。它是用YANG数据定义语句定义的。

  • 数据存储资源：使用NETCONF数据存储概念建立编程接口的资源。默认情况下，RESTCONF方法访问服务器上基础数据存储实现的统一视图。它被定义为API资源中的一个子资源。

  • 编辑操作：使用POST，PUT，PATCH或DELETE方法对数据资源执行RESTCONF操作。这与NETCONF编辑操作（即，“nc:operation”属性的值之一：“create”，“replace”，“merge”，“delete”或“remove”）不相同。

  • 事件流资源：表示SSE（Server-Sent Events）事件流的资源。内容由使用媒体类型“text/event-stream”的文本组成，如SSE规范[W3C.REC-eventsource-20150203]所定义。事件流内容在3.8节中描述。

  • 媒体类型：为了提供开放和可扩展的数据类型和类型协商，HTTP使用“Content-Type”和“Accept”头字段中的Internet媒体类型[RFC2046]。

  • NETCONF客户端：实现NETCONF协议​​的客户端。在[RFC6241]中称为“客户端”。

  • NETCONF服务器：实现NETCONF协议​​的服务器。在[RFC6241]中称为“服务器”。

  • 操作：从HTTP方法，请求URI，头字段和消息体派生的消息的概念RESTCONF操作。

  • 操作资源：一种对数据模型特定操作进行建模的资源，该操作又由YANG的“rpc”或“action”语句定义。它是用POST方法调用的。

  • 修补程序：目标数据存储或数据资源上的PATCH方法。消息体内容的媒体类型将识别正在使用的补丁类型。

  • 普通补丁：用于PATCH方法的特定媒体类型;见第4.6.1节。它可以用于简单的“merge”编辑操作。它由“application/yang-data+xml”或“application/yang-data+json”的请求Content-Type指定。

  • 查询参数：在请求URI的查询组件中编码的参数（及其值，如果有的话）。

  • 资源类型：本文档中定义的RESTCONF资源类之一。 “API”，“数据存储”(datastore)，“数据”(data)，“操作”(operation)，“模式”(schema)或“事件流”(envent stream)之一。

  • RESTCONF功能：一个可选的RESTCONF协议​​功能，如果该功能在该服务器上受支持，则由特定服务器通告。该功能由IANA注册的NETCONF Capability URI标识，并在第9.3节中定义的“能力”(capability)叶子列表中的条目中公布。

  • RESTCONF客户端：实现RESTCONF协议​​的客户端。

  • RESTCONF服务器：实现RESTCONF协议​​的服务器。

  • 检索请求：使用GET或HEAD方法的请求。

  • 模式资源：客户端使用GET方法检索YANG模式的资源。它具有媒体类型“application/yang”的表示。

  • 服务器：RESTCONF服务器。

  • “流”列表：描述从服务器可用的事件流资源的数据资源实例集合。该信息在“ietf-restconf-monitoring”模块中定义为“流”(stream)列表。它可以使用目标资源“{+restconf}/data/ietf-restconf-monitoring:restconf-state/streams/stream”进行检索。 “流”列表包含关于每个流的信息，诸如用于检索事件流数据的URL。

  • 流资源：一个事件流资源。

  • 目标资源：与由请求URI的“path”组件标识的特定消息相关联的资源。

  • yang-data扩展：符合第8节中“yang-data”扩展语句的YANG外部语句。yang-data扩展用于定义将用作YANG数据模板的YANG数据结构。这些数据结构不是作为配置数据存储的一部分或作为服务器内的操作状态实现的，所以不能使用正常的YANG数据定义语句。

  • YANG数据模板：使用YANG将协议消息组件建模为概念数据结构的模式。这允许消息以与编码无关的方式来定义。每个YANG数据模板用第8节中的“yang-data”扩展定义。可以为YANG定义符合特定YANG数据模板的实例的表示。 XML表示在YANG版本1.1[RFC7950]中定义，并且由“application/yang-data+xml”媒体类型支持。 JSON表示在“使用YANG建模的JSON数据编码”[RFC7951]中定义，并且由“application/yang-data+json”媒体类型支持。