ゲートウェイ API を使用してONTAPボリュームのトラブルシューティングを行う
ゲートウェイAPIは、ONTAP APIを呼び出してONTAPストレージ オブジェクトに関する情報を照会し、修正策を実施して報告された問題に対処するためのゲートウェイとして機能します。
このワークフローでは、ONTAPボリュームの容量がほぼフルに達したときにイベントが生成されるユースケースを例に取り上げます。ワークフローには、Active IQ Unified ManagerとONTAPそれぞれのREST APIを呼び出してこの問題に対処する手順も含まれています。
|
ワークフローの手順を実行する前に、次の点を確認してください。
|
次の図は、ONTAPボリュームの使用容量に関する問題をトラブルシューティングするためのワークフローの各手順を示したものです。

このワークフローには、Unified ManagerとONTAP両方のREST APIの呼び出しポイントが含まれています。
-
ボリュームの使用容量を通知するイベントからボリューム名をメモします。
-
ボリューム名をnameパラメータに指定し、次のUnified Manager APIを実行してボリュームを照会します。
カテゴリ HTTP動詞 パス datacenter
GET
/datacenter/storage/volumes
-
出力からクラスタのUUIDとボリュームのUUIDを取得します。
-
Unified Manager Web UI で、一般 > 機能設定 > API ゲートウェイ に移動して、API ゲートウェイ機能が有効になっているかどうかを確認します。この機能が有効になっていないと、gatewayカテゴリのAPIを呼び出すことはできません。無効になっている場合は有効にします。
-
クラスタUUIDを使用してONTAP APIを実行します/`storage/volumes/{uuid}`APIゲートウェイ経由で。APIパラメータとしてボリュームのUUIDを渡した場合は、ボリュームの詳細が返されます。
APIゲートウェイを使用してONTAP APIを実行する場合、Unified Managerのクレデンシャルが内部で渡されて認証されます。このため、クラスタ アクセスのたびに認証手順を実行する必要はありません。
カテゴリ HTTP動詞 パス Unified Manager:gateway
ONTAP:storage
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>"
-
サイズ、使用量、および実施する修正策を出力から確認します。このワークフローでは、ボリュームのサイズを変更します。
-
クラスタのUUIDを使用し、APIゲートウェイを使用して次のONTAP APIを実行し、ボリュームのサイズを変更します。ゲートウェイAPIとONTAP APIの入力パラメータについては、手順5を参照してください。
カテゴリ HTTP動詞 パス Unified Manager:gateway
ONTAP:storage
PATCH
ゲートウェイ API:
/gateways/{uuid}/{path}
ONTAP API:
/storage/volumes/{uuid}
ボリュームのサイズを変更するには、クラスタのUUIDとボリュームのUUIDに加え、sizeパラメータの値を入力する必要があります。必ず値をバイト単位で入力してください。たとえば、ボリュームのサイズを 100 GB から 120 GB に増やしたい場合は、クエリの最後にパラメータ size の値を入力します。
-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が返されます。
-
ジョブのUUIDを使用して、ジョブが正常に実行されたかどうかを確認します。クラスタのUUIDとジョブのUUIDを使用し、APIゲートウェイを使用して次のONTAP APIを実行します。ゲートウェイAPIとONTAP APIの入力パラメータについては、手順5を参照してください。
カテゴリ HTTP動詞 パス Unified Manager:gateway
ONTAP:cluster
GET
ゲートウェイ API:
/gateways/{uuid}/{path}
ONTAP API:
/cluster/jobs/{uuid}
返されるHTTPコードは、ONTAP REST APIのHTTPステータス コードと同じです。
-
次のONTAP APIを実行して、サイズ変更後のボリュームの詳細を照会します。ゲートウェイAPIとONTAP APIの入力パラメータについては、手順5を参照してください。
カテゴリ HTTP動詞 パス Unified Manager:gateway
ONTAP:storage
GET
ゲートウェイ API:
/gateways/{uuid}/{path}
ONTAP API:
/storage/volumes/{uuid}
出力には拡張後のボリューム サイズとして120GBと表示されます。