了解如何使用 Element API 管理存储
建议更改
PDF
Element API 基于 HTTPS 上的 JSON-RPC 协议。JSON-RPC 是一种基于轻型 JSON 数据交换格式的简单文本 RPC 协议。客户端库可用于所有主要编程语言。
您可以通过 HTTPS POST 请求向 API 端点发出 API 请求。POST 请求的正文是一个 JSON-RPC 请求对象。API 当前不支持批处理请求（在一个 POST 中包含多个请求对象）。在提交 API 请求时，必须使用 "application/json-rpc" 作为请求的内容类型，并确保正文未进行格式编码。
|
Element Web UI 会使用本文档中所述的 API 方法。您可以通过启用 API 日志来监控 UI 中的 API 操作；这样，您可以查看向系统发出的方法。您可以同时启用请求和响应，以查看系统如何对发出的方法做出响应。 |
除非另有说明，否则 API 响应中的所有日期字符串均采用 UTC+0 格式。
|
|
如果存储集群负载过重，或者您连续提交多个 API 请求而没有中间延迟，则某个方法可能会失败并返回错误 "xDBVersionMismatch" 。如果发生这种情况，请重试方法调用。 |
通用对象
Element 软件 API 使用 JSON 对象来表示组织的数据概念。其中许多 API 方法都使用这些对象进行数据输入和输出。本节介绍了这些常用对象；仅在一种方法中使用的对象将使用该方法记录，而不是在本节中记录。
通用方法
常用方法是用于检索有关存储集群， API 本身或正在进行的 API 操作的信息的方法。
帐户 API 方法
使用帐户方法可以添加，删除，查看和修改帐户和安全信息。
管理员 API 方法
您可以使用管理员 API 方法创建，修改，查看和删除存储集群管理员，并为有权访问存储集群的管理员分配访问级别和特权。
集群 API 方法
您可以通过 Element 软件集群 API 方法管理存储集群以及属于存储集群的节点的配置和拓扑。
某些集群 API 方法可在属于集群一部分或已配置为加入集群的节点上运行。您可以向新集群或现有集群添加节点。已准备好添加到集群的节点处于 " 待定 " 状态，这意味着它们已配置，但尚未添加到集群。
集群创建 API 方法
您可以使用这些 API 方法创建存储集群。需要对单个节点上的 API 端点使用所有这些方法。
驱动器 API 方法
您可以使用驱动器 API 方法添加和管理可供存储集群使用的驱动器。将存储节点添加到存储集群或在现有存储节点中安装新驱动器时，可以将这些驱动器添加到存储集群中。
光纤通道 API 方法
您可以使用光纤通道 API 方法添加，修改或删除存储集群的光纤通道节点成员。
启动程序 API 方法
通过启动程序方法，您可以添加，删除，查看和修改 iSCSI 启动程序对象，这些对象用于处理存储系统与外部存储客户端之间的通信。
LDAP API 方法
您可以使用轻型目录访问协议（ Lightweight Directory Access Protocol ， LDAP ）对 Element 存储的访问进行身份验证。使用本节所述的 LDAP API 方法，您可以配置对存储集群的 LDAP 访问。
多因素身份验证 API 方法
您可以使用多因素身份验证（ Multi-Factor Authentication ， MFA ）通过安全断言标记语言（ Security Assertion Markup Language ， SAML ）使用第三方身份提供程序（ IdP ）管理用户会话。
会话身份验证 API 方法
您可以使用基于会话的身份验证来管理用户会话。
节点 API 方法
您可以使用节点 API 方法配置单个节点。这些方法可在需要配置，已配置但尚未加入集群或正在积极加入集群的单个节点上运行。通过节点 API 方法，您可以查看和修改各个节点以及用于与节点通信的集群网络的设置。您必须对单个节点运行这些方法；不能对集群地址运行每个节点 API 方法。
复制 API 方法
通过复制 API 方法，您可以连接两个集群以实现持续数据保护（ Continuous Data Protection ， CDP ）。连接两个集群时，可以将集群中的活动卷持续复制到另一个集群，以提供数据恢复。通过将卷配对以进行复制，您可以保护数据免受可能导致其无法访问的事件的影响。
安全 API 方法
您可以将 Element 软件与外部安全相关服务集成，例如外部密钥管理服务器。通过这些与安全相关的方法，您可以为空闲加密配置外部密钥管理等要素安全功能。
SnapMirror API 方法
Element Web UI 使用 SnapMirror API 方法管理通过远程 ONTAP 系统镜像的快照。这些方法仅供 Element Web UI 使用。如果需要通过 API 访问 SnapMirror 功能，请使用 ONTAP API 。不提供 SnapMirror API 方法的请求和返回示例。
系统配置 API 方法
您可以通过系统配置 API 方法获取和设置应用于集群中所有节点的配置值。
多租户网络 API 方法
Element 存储集群中的多租户网络允许在不同逻辑网络上的多个客户端之间将流量连接到一个 Element 存储集群，而无需第 3 层路由。
通过使用 VLAN 标记，与存储集群的连接在网络堆栈中隔离。
设置多租户虚拟网络的前提条件
-
您必须已确定要分配给存储节点上虚拟网络的客户端网络 IP 地址块。
-
您必须已确定要用作所有存储流量的端点的客户端存储网络 IP （ SVIP ）地址。
虚拟网络操作顺序
-
使用 AddVirtualNetwork 方法批量配置输入的 IP 地址。
添加虚拟网络后，集群将自动执行以下步骤：
-
每个存储节点都会创建一个虚拟网络接口。
-
系统会为每个存储节点分配一个 VLAN 地址，此地址可使用虚拟 SVIP 路由到。
-
节点重新启动时， VLAN IP 地址会在每个节点上保留。
-
-
分配虚拟网络接口和 VLAN 地址后，您可以将客户端网络流量分配给虚拟 SVIP 。
卷 API 方法
通过 Element 软件卷 API 方法，您可以管理驻留在存储节点上的卷。您可以使用以下方法创建，修改，克隆和删除卷。您还可以使用卷 API 方法收集和显示卷的数据测量结果。
卷访问组 API 方法
通过卷访问组方法，您可以添加，删除，查看和修改卷访问组，这些卷访问组是用户可以使用 iSCSI 或光纤通道启动程序访问的卷的集合。
卷快照 API 方法
您可以通过 Element 软件卷快照 API 方法管理卷快照。您可以使用卷快照 API 方法创建，修改，克隆和删除卷快照。
虚拟卷 API 方法
您可以通过 Element 软件虚拟卷 API 方法管理虚拟卷（ VVOL ）。您可以使用这些 API 方法查看现有 VVOL ，以及创建，修改和删除虚拟卷存储容器。虽然您无法使用这些方法对普通卷执行操作，但可以使用普通卷 API 方法列出有关 VVOL 的信息。