解释 API 响应

每个 API 请求都会生成一个对客户端的响应。您应该检查响应以确定其是否成功并根据需要检索其他数据。

HTTP 状态代码

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

代码 含义 说明
200 确定 表示不创建新对象的调用成功。
201 已创建 已成功创建对象。响应中的位置标题包括对象的唯一标识符。
202. 已接受 已启动后台作业以执行请求、但尚未完成。
400 错误的请求 请求输入未被识别或不合适。
401 未授权 用户身份验证失败。
403 已禁止 由于授权 (RBAC) 错误而拒绝访问。
404. 未找到 请求中引用的资源不存在。
405 不允许使用方法 资源不支持请求中的 HTTP 方法。
409. 冲突 创建对象的尝试失败,因为必须先创建另一个对象或请求的对象已存在。
500 内部错误 服务器上发生一般内部错误。

响应报头

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

位置

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

内容类型
这通常是application/hal+json

响应主体

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

HAL 链接

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

错误

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

格式
错误对象的格式如下:
"error": {
   " 信息 " : " 、
   " 代码 ":< 整数 >[,
   " 目标 " : " <string> "]
}
您可以使用代码值来确定一般错误类型或类别、以及确定特定错误的消息。如果可用,目标字段将包括与错误相关的特定用户输入。
常见错误代码
下表介绍了常见错误代码。特定 API 调用可能包括其他错误代码。
错误代码 HTTP 状态代码 说明
1 409. 具有相同标识符的对象已存在。
2 400 字段的值具有无效值或缺少值、或者提供了额外字段。
3 400 不支持该操作。
4 405 找不到具有指定标识符的对象。
6 403 拒绝执行请求的权限。
8 409. 资源正在使用中。