Skip to main content
Active IQ Unified Manager
简体中文版经机器翻译而成,仅供参考。如与英语版出现任何冲突,应以英语版为准。

使用网关 API 对ONTAP卷进行故障排除

网关 API 充当网关,调用ONTAP API 来查询有关ONTAP存储对象的信息并采取补救措施来解决报告的问题。

此工作流程采用一个示例用例,其中当ONTAP卷几乎达到其容量时会引发一个事件。该工作流程还演示了如何通过调用Active IQ Unified Manager和ONTAP REST API 的组合来解决此问题。

备注

在运行工作流步骤之前,请确保以下事项:

  • 您了解网关 API 及其使用方法。有关信息,请参阅"通过代理访问ONTAP API"

  • 您了解ONTAP REST API 的用法。有关使用ONTAP REST API 的信息,请参阅https://docs.netapp.com/us-en/ontap-automation/index.html["ONTAP自动化文档"]。

  • 您是应用程序管理员。

  • 您要在其上运行 REST API 操作的集群受ONTAP 9.5 或更高版本支持,并且该集群通过 HTTPS 添加到 Unified Manager。

下图说明了解决ONTAP卷容量使用问题的工作流中的每个步骤。

API 网关 ONTAP 工作流程

该工作流程涵盖 Unified Manager 和ONTAP REST API 的调用点。

  1. 记下通知卷容量利用率的事件中的卷名称。

  2. 通过使用卷名称作为名称参数中的值,通过运行以下 Unified Manager API 来查询卷。

    类别 HTTP 动词 路径

    数据中心

    GET

    /datacenter/storage/volumes

  3. 从输出中检索集群 UUID 和卷 UUID。

  4. 在 Unified Manager Web UI 上,导航到 常规 > 功能设置 > API 网关 以验证 API 网关功能是否已启用。除非启用,否则网关类别下的 API 不可供您调用。如果该功能被禁用,请启用它。

  5. 使用集群 UUID 运行ONTAP API/`storage/volumes/{uuid}`通过 API 网关。当卷 UUID 作为 API 参数传递时,查询将返回卷详细信息。

    要通过 API 网关运行ONTAP API,Unified Manager 凭据会在内部传递以进行身份​​验证,并且您不需要为单个集群访问运行额外的身份验证步骤。

    类别 HTTP 动词 路径

    统一管理器:网关

    ONTAP:存储

    GET

    网关 API: /gateways/{uuid}/{path}

    ONTAP API: /storage/volumes/{uuid}

    备注

    在 /gateways/{uuid}/{path} 中,{uuid} 的值必须替换为要执行 REST 操作的集群 UUID。 {path} 必须替换为ONTAP REST URL /storage/volumes/{uuid}。

    附加的 URL 是: /gateways/{cluster_uuid}/storage/volumes/{volume_uuid}

    运行 GET 操作时,生成的 URL 为: GEThttps://<hostname\>/api/gateways/<cluster_UUID\>/storage/volumes/{volume_uuid}

    示例 cURL 命令

    curl -X GET "https://<hostname>/api/gateways/1cd8a442-86d1-11e0-ae1c-9876567890123/storage/volumes/028baa66-41bd-11e9-81d5-00a0986138f7"
    -H "accept: application/hal+json" -H "Authorization: Basic <Base64EncodedCredentials>"
  6. 根据输出,确定大小、用途和要采取的补救措施。在此工作流程中,采取的补救措施是调整卷大小。

  7. 使用集群 UUID 并通过 API 网关运行以下ONTAP API 来调整卷大小。有关网关和ONTAP API 的输入参数的信息,请参阅步骤 5。

    类别 HTTP 动词 路径

    统一管理器:网关

    ONTAP:存储

    修补

    网关 API: /gateways/{uuid}/{path}

    ONTAP API: /storage/volumes/{uuid}

    备注

    除了集群 UUID 和卷 UUID 之外,您还必须输入用于调整卷大小的大小参数值。确保以字节为单位输入值。例如,如果要将卷的大小从 100 GB 增加到 120 GB,请在查询末尾输入参数大小的值: -d {\"size\": 128849018880}"

    示例 cURL 命令

    curl -X PATCH "https://<hostname>/api/gateways/1cd8a442-86d1-11e0-ae1c-9876567890123/storage/volumes/028baa66-41bd-11e9-81d5-00a0986138f7" -H
        "accept: application/hal+json" -H "Authorization: Basic <Base64EncodedCredentials>" -d
        {\"size\": 128849018880}"

    JSON 输出返回作业 UUID。

  8. 使用作业 UUID 验证作业是否成功运行。使用集群 UUID 和作业 UUID 通过 API 网关运行以下ONTAP API。有关网关和ONTAP API 的输入参数的信息,请参阅步骤 5。

    类别 HTTP 动词 路径

    统一管理器:网关

    ONTAP:集群

    GET

    网关 API: /gateways/{uuid}/{path}

    ONTAP API: /cluster/jobs/{uuid}

    返回的 HTTP 代码与ONTAP REST API HTTP 状态代码相同。

  9. 运行以下ONTAP API 来查询已调整大小的卷的详细信息。有关网关和ONTAP API 的输入参数的信息,请参阅步骤 5。

    类别 HTTP 动词 路径

    统一管理器:网关

    ONTAP:存储

    GET

    网关 API: /gateways/{uuid}/{path}

    ONTAP API: /storage/volumes/{uuid}

    输出显示卷大小增加到了 120 GB。