每个 API 请求都会生成一个对客户端的响应。您应该检查响应以确定其是否成功并根据需要检索其他数据。
下面介绍了 ONTAP REST API 使用的 HTTP 状态代码。
代码 | 含义 | 说明 |
---|---|---|
200 | 确定 | 表示不创建新对象的调用成功。 |
201 | 已创建 | 已成功创建对象。响应中的位置标题包括对象的唯一标识符。 |
202. | 已接受 | 已启动后台作业以执行请求、但尚未完成。 |
400 | 错误的请求 | 请求输入未被识别或不合适。 |
401 | 未授权 | 用户身份验证失败。 |
403 | 已禁止 | 由于授权 (RBAC) 错误而拒绝访问。 |
404. | 未找到 | 请求中引用的资源不存在。 |
405 | 不允许使用方法 | 资源不支持请求中的 HTTP 方法。 |
409. | 冲突 | 创建对象的尝试失败,因为必须先创建另一个对象或请求的对象已存在。 |
500 | 内部错误 | 服务器上发生一般内部错误。 |
ONTAP 生成的 HTTP 响应中包含多个标头。
根据对象、处理类型以及请求的成功或失败情况, API 请求所产生的响应主体的内容会有所不同。响应始终在 JSON 中呈现。
可以根据请求返回一个对象以及一组字段。例如,可以使用 GET 使用唯一标识符检索集群的选定属性。
可以从资源集合返回多个对象。在所有情况num_recordsrecords下,都使用一致的格式、指示记录数量并包含对象实例的数组。例如,您可以检索在特定集群中定义的节点。
如果 API 调用是异步处理的、则会返回一个作业对象、该作业对象将锁定后台任务。例如,用于更新集群配置的修补程序请求将异步处理并返回作业对象。
如果发生错误,则始终返回错误对象。例如,尝试更改未定义的群集字段时将收到错误。
在某些情况下、不返回任何数据、响应主体包括空的 JSON 对象。
ONTAP REST API 使用 HAL 作为支持超级媒体的机制、将其作为应用程序状态 (HateOAS) 的引擎。当返回标识特定资源的对象或属性时,还会包含一个 HAL 编码链接、允许您轻松查找并确定有关该资源的其他详细信息。
如果发生错误,则会在响应主体中返回错误对象。
"error": { " 信息 " : " 、 " 代码 ":< 整数 >[, " 目标 " : " <string> "] }
错误代码 | HTTP 状态代码 | 说明 |
---|---|---|
1 | 409. | 具有相同标识符的对象已存在。 |
2 | 400 | 字段的值具有无效值或缺少值、或者提供了额外字段。 |
3 | 400 | 不支持该操作。 |
4 | 405 | 找不到具有指定标识符的对象。 |
6 | 403 | 拒绝执行请求的权限。 |
8 | 409. | 资源正在使用中。 |