メインコンテンツまでスキップ

APIサービスとUnified Manager 9.7 REST APIのマッピング

Views:
8
Visibility:
Public
Votes:
0
Category:
oncommand-unified-manager
Specialty:
legacy
Last Updated:

環境

Unified Manager 9.7

回答

OnCommand APIサービスにはどのような機能があり、どのくらいの期間サポートされますか。 

OnCommand APIサービス製品にはREST APIが用意されています。パートナーアプリケーションは、これらのAPIを使用して、NetApp ONTAP® ソフトウェアで実行されているストレージシステム上で、指定されたデータストレージの監視、情報の読み出し処理、およびアクティブ管理をプログラムで実行します。  

OnCommand APIサービス2.2は、2021年4月までサポートされます。  

APIサービスREST API機能を取得できる製品はありますか。 

OnCommand APIサービスが提供するREST API機能は、Unified Manager 9.7データセンターを対象としたREST APIから取得でき、ゲートウェイを使用してONTAP REST APIを呼び出すことができます。 

Unified ManagerゲートウェイAPIを使用するメリットは何ですか。 

ゲートウェイAPIには、Active IQ Unified Managerクレデンシャルを使用してONTAPシステムを対象としたREST APIを実行したり、ストレージオブジェクトを管理したりできるという利点があります。 

また、APIを実行するための追加のシステムをインストールする必要がなく、データセンターレベルおよびクラスタレベルでONTAPをプログラム的に管理できます。Unified Manager 9.7およびONTAP 9.7で使用可能なREST APIを使用することを推奨します。ONTAPは今後も新機能用のREST APIエンドポイントを提供していきます。  

現在自動化にAPIサービスを使用していますが、これらの機能を提供する製品を教えてください。 

既存のAPIサービスユーザを有効にするために、Active IQ Unified Manager 9.7 REST APIエンドポイントへのAPIサービスREST APIのマッピング については、 OnCommand_APIs_to_UM_APIs_Mapping.xlsx ExcelシートOnCommand_APIs_to_UM_APIs_Mapping.xlsxを参照してください。 

注:

  •  AIQ UM APIは、API Servicesと同じデータ形式のレコードや情報を返しません。  

  • また、AIQ UMのゲートウェイAPIは、データセンターを対象としたAPIとは異なるデータモデルを提供します。 

例:JSON構造、パラメータ名  

このマッピングドキュメントの読み方 

このドキュメントで使用されている用語: 

  • APIサービスAPIパス: APIサービスREST APIエンドポイント  

  • AIQ UM 9.7 APIパス: Unified Manager 9.7 REST APIエンドポイント  

  • タイプ: 

  • AIQ UM APIUMから直接APIエンドポイントを取得 

  • APIゲートウェイ:UMからONTAP REST APIエンドポイントにパススルー  

  • サポートなし:同等のAPIエンドポイントがありません 

  • 範囲:  

  • データセンターレベル:プロセスAPIクエリを実行し、データセンターレベルで実行 

  • クラスタレベル:APIクエリを処理し、クラスタレベルで実行 

例1: 

ユーザがAPI-S ONTAPエンドポイントGET /6.0 / API/Aggregatesを使用して アグリゲートの詳細を取得している場合は、データセンターを対象としたUnified Manager 9.7で同等のAPIを使用できます。 /api/v2/datacenter/storage/aggregates エンドポイントを取得します。 

例2:  

ユーザがAPI-S ONTAPエンドポイントPOST /6.0 / API/アグリゲートを使用して アグリゲートを作成している場合は、クラスタを対象としたUnified Manager 9.7ゲートウェイREST APIエンドポイントで同等の機能を利用できます。POST /api/v2/gateways/{cluster}/ストレージ/アグリゲート  

注: ゲートウェイAPIは、ONTAPシステムを対象としたREST APIを実行するためのActive IQ Unified Managerクレデンシャルを提供します。 

APIサービスは変更をキャッシュできます。この機能はAIQ UM製品で提供されますか。 

APIサービスでは、変更をキャッシュして、クラスタでの次回のデータ取得までGET処理に使用できます。AIQ Unified Managerは、クラスタで次回データを取得するまで変更を認識しません。  このシナリオの回避策では、GET ON GATEWAY APIを使用して変更を認識します。   

シナリオ: UMゲートウェイAPIを使用した新しいボリュームの作成 

  1. ゲートウェイを使用したONTAPへのボリュームの配置(新しく作成したボリュームのUUIDをキャッシュ) 

  1. Gateway API Volume GETを使用してボリュームを取得し、ボリュームに対して処理を実行します。 

  1. Unified Managerの次回の取得サイクル内にプロビジョニングを決定するには、Gateway APIを使用してアグリゲートの容量の詳細を取得する 

詳細については、次を参照してください。  

追加情報

AdditionalInformation_text

 

NetApp provides no representations or warranties regarding the accuracy or reliability or serviceability of any information or recommendations provided in this publication or with respect to any results that may be obtained by the use of the information or observance of any recommendations provided herein. The information in this document is distributed AS IS and the use of this information or the implementation of any recommendations or techniques herein is a customer's responsibility and depends on the customer's ability to evaluate and integrate them into the customer's operational environment. This document and the information contained herein may be used solely in connection with the NetApp products discussed in this document.