基本运行特征

请求和响应 API 事务​

每个 REST API 调用都作为对 ONTAP 系统的 HTTP 请求执行，然后该系统会生成对客户端的关联响应。此请求/响应对被视为 API 事务。在使用 API 之前，您应该熟悉可用于控制请求的输入变量以及响应输出的内容。

支持 CRUD 操作​

通过 ONTAP REST API 提供的每个资源都是基于 CRUD 模型访问的：

• 创建

• 读取

• 更新

• 删除

对于某些资源，仅支持其中一部分操作。您应该查看 ONTAP 集群的 ONTAP API 文档页面，以获取有关每个资源的更多信息。

对象标识​

在创建每个资源实例或对象时会为其分配唯一标识。在大多数情况下，该标识为 128 位 UUID。这些标识在特定 ONTAP 集群中是全局唯一的。在发出创建新对象实例的 API 调用后，系统将在 HTTP 响应的 location 标头中向调用者返回具有相关标识值的 URL。可以提取标识并在后续调用中引用资源实例时使用该标识。

对象实例和集合​

根据资源路径和 HTTP 方法，API 调用可以应用于特定对象实例或对象集合。

同步和异步操作​

ONTAP 通过两种方式执行从客户端收到的 HTTP 请求。

同步处理

ONTAP 立即执行请求，如果成功则以 HTTP 状态代码 200 或 201 做出响应。

每个使用 GET、HEAD 和 OPTIONS 方法的请求始终是同步执行的。此外，使用 POST、PATCH 和 DELETE 的请求如果预期在不到两秒的时间内完成，则会设计为同步运行。

异步处理

如果异步请求有效，则 ONTAP 会创建一个后台任务来处理请求，并创建一个作业对象来锚定任务。202 HTTP 状态随作业对象一起返回给调用者。为确定最终成功还是失败，必须检索作业的状态。

使用 POST、PATCH 和 DELETE 方法的请求如果预期需要超过两秒的时间才能完成，则会设计为异步运行。

注

return_timeout 查询参数可用于异步的 API 调用，并可以将异步调用转换为以同步方式完成。请参阅《异步处理在使用作业对象时的工作原理》以获取更多信息。

安全性​

通过 REST API 提供的安全性主要基于 ONTAP 附带的现有安全功能。该 API 使用以下安全性：

• 传输层安全性

  通过网络在 ONTAP LIF 和客户端之间发送的所有流量通常使用 TLS 加密，具体取决于 ONTAP 配置设置。

• 客户端认证

  ThinkSystem DM 系列存储管理软件和 Network Manageability SDK 附带的相同认证选项也可用于 ONTAP REST API。

• HTTP 认证

  在 HTTP 级别，API 事务采用基本认证。每个请求都会添加一个在 base64 字符串中包含用户名和密码的 HTTP 标头。

• ONTAP 授权

  ONTAP 采用基于角色的授权模型。在访问 ONTAP REST API 或 API 文档页面时使用的帐户应具有正确授权。