解释 API 响应

HTTP 状态代码

下面介绍了 ONTAP REST API 使用的 HTTP 状态代码。

响应报头

ONTAP 生成的 HTTP 响应中包含多个标头。

位置

创建对象时、位置标题包括新对象的完整 URL 、包括分配给该对象的唯一标识符。

内容类型

这通常是application/hal+json。

响应主体

根据对象、处理类型以及请求的成功或失败情况， API 请求所产生的响应主体的内容会有所不同。响应始终在 JSON 中呈现。

• 单一对象

  可以根据请求返回一个对象以及一组字段。例如，可以使用 GET 使用唯一标识符检索集群的选定属性。

• 多个对象

  可以从资源集合返回多个对象。在所有情况num_recordsrecords下，都使用一致的格式、指示记录数量并包含对象实例的数组。例如，您可以检索在特定集群中定义的节点。

• 作业对象

  如果 API 调用是异步处理的、则会返回一个作业对象、该作业对象将锁定后台任务。例如，用于更新集群配置的修补程序请求将异步处理并返回作业对象。

• 错误对象

  如果发生错误，则始终返回错误对象。例如，尝试更改未定义的群集字段时将收到错误。

• 空

  在某些情况下、不返回任何数据、响应主体包括空的 JSON 对象。

HAL 链接

ONTAP REST API 使用 HAL 作为支持超级媒体的机制、将其作为应用程序状态 (HateOAS) 的引擎。当返回标识特定资源的对象或属性时，还会包含一个 HAL 编码链接、允许您轻松查找并确定有关该资源的其他详细信息。

错误

如果发生错误，则会在响应主体中返回错误对象。

格式

错误对象的格式如下：

"error": {
   " 信息 " ： " 、
   " 代码 ":< 整数 >[,
   " 目标 " ： " <string> "]
}

您可以使用代码值来确定一般错误类型或类别、以及确定特定错误的消息。如果可用，目标字段将包括与错误相关的特定用户输入。

常见错误代码

下表介绍了常见错误代码。特定 API 调用可能包括其他错误代码。