eternus restful api リファレンス...restful...

FUJITSU StorageETERNUS AF S3 series オールフラッシュアレイ,ETERNUS DX S5 series, ETERNUS DX8100 S4/DX8900 S4ハイブリッドストレージシステム

ETERNUS RESTful API リファレンス

RESTful API を使用した設定/運用管理

P3AG-5492-01Z0

目次

第 1 章概要...................................................................................................71.1 概要 ............................................................................................................................71.2 RESTful API へのアクセス.............................................................................................71.3 RESTful API 設定..........................................................................................................71.4 Firewall 設定...............................................................................................................7

第 2 章権限...................................................................................................8

第 3 章制限事項 ............................................................................................93.1 メインフレーム機能 .....................................................................................................93.2 Unified 機能................................................................................................................93.3 アドバンスト・コピー機能 ...........................................................................................93.4 ボリュームタイプ ........................................................................................................93.5 ホスト・コネクション..................................................................................................9

3.5.1 ホストタイプ .................................................................................................................................9

3.5.2 グループ化による設定 ....................................................................................................................9

3.5.3 任意のホストとのコネクション設定 ..............................................................................................10

第 4 章インターフェース .............................................................................114.1 HTTP メソッド...........................................................................................................114.2 HTTP クライアント・ヘッダー....................................................................................114.3 URI ...........................................................................................................................11

4.3.1 表示する項目の絞り込み...............................................................................................................12

4.3.2 表示するリソースの絞り込み ........................................................................................................12

4.4 ボディ.......................................................................................................................134.4.1 リクエストボディ.........................................................................................................................13

4.4.2 レスポンスボディ.........................................................................................................................13

4.5 応答 ..........................................................................................................................134.5.1 成功時の応答 ...............................................................................................................................13

4.5.2 エラー時の応答 ............................................................................................................................13

第 5 章ログインとログアウト.......................................................................155.1 ログイン....................................................................................................................155.2 ログアウト ................................................................................................................15

2 ETERNUS RESTful API リファレンス

第 6 章ジョブ管理 .......................................................................................16

第 7 章コマンドリファレンス.......................................................................177.1 セッション ................................................................................................................17

7.1.1 Session の作成.............................................................................................................................17

7.1.2 Session の削除.............................................................................................................................19

7.1.3 Session 情報の取得 ......................................................................................................................20

7.2 ジョブ.......................................................................................................................217.2.1 全 Job 情報の取得.........................................................................................................................21

7.2.2 Job 情報の削除.............................................................................................................................23

7.2.3 Job 情報の取得.............................................................................................................................24

7.2.4 Job のキャンセル..........................................................................................................................27

7.3 ストレージシステム ...................................................................................................287.3.1 装置情報の取得 ............................................................................................................................28

7.4 コンポーネント..........................................................................................................327.4.1 Frontend Enclosure 情報の取得....................................................................................................32

7.4.2 全 Controller Enclosure 情報の取得 ..............................................................................................37

7.4.3 Controller Enclosure 情報の取得...................................................................................................39

7.4.4 全 CA Port の情報の取得 ...............................................................................................................44

7.4.5 CA Port の情報の取得 ...................................................................................................................47

7.4.6 全 Drive Enclosure 情報の取得......................................................................................................51

7.4.7 Drive Enclosure 情報の取得..........................................................................................................53

7.4.8 全 Drive 情報の取得......................................................................................................................57

7.4.9 Drive 設定の変更..........................................................................................................................60

7.4.10 Drive 情報の取得........................................................................................................................62

7.5 Thin Provisioning Pool..............................................................................................667.5.1 Thin Provisioning Pool の作成 .....................................................................................................66

7.5.2 全 Thin Provisioning Pool 情報の取得...........................................................................................71

7.5.3 Thin Provisioning Pool 設定の変更...............................................................................................74

7.5.4 Thin Provisioning Pool の削除 .....................................................................................................77

7.5.5 Thin Provisioning Pool 情報の取得...............................................................................................78

7.5.6 Thin Provisioning Pool の拡張 .....................................................................................................82

7.6 Flexible Tier Pool......................................................................................................857.6.1 全 Flexible Tier Pool 情報の取得...................................................................................................85

7.6.2 Flexible Tier Pool 情報の取得 .......................................................................................................87

目次


7.7 RAID グループ ...........................................................................................................897.7.1 RAID Group の作成.......................................................................................................................89

7.7.2 全 RAID Group 情報の取得............................................................................................................92

7.7.3 RAID Group の設定変更 ................................................................................................................95

7.7.4 RAID Group の削除.......................................................................................................................97

7.7.5 RAID Group 情報の取得 ................................................................................................................98

7.8 ボリューム ..............................................................................................................1027.8.1 Volume の作成 ..........................................................................................................................102

7.8.2 Volume の削除 ..........................................................................................................................105

7.8.3 全 Volume 情報の取得................................................................................................................107

7.8.4 Volume 設定の変更....................................................................................................................110

7.8.5 Volume の削除 ..........................................................................................................................112

7.8.6 Volume 情報の取得....................................................................................................................114

7.8.7 Volume 容量の拡張....................................................................................................................119

7.9 ホスト接続 ..............................................................................................................1217.9.1 Host の登録 ...............................................................................................................................121

7.9.2 全 Host 情報の取得.....................................................................................................................124

7.9.3 Host 設定の変更.........................................................................................................................126

7.9.4 Host の削除 ...............................................................................................................................129

7.9.5 Host 情報の取得.........................................................................................................................130

7.9.6 複数 Host Connection の作成 .....................................................................................................132

7.9.7 複数 Host Connection の削除 .....................................................................................................134

7.9.8 Host Connection の作成.............................................................................................................136

7.9.9 Host Connection 情報の取得 ......................................................................................................138

7.9.10 Host Connection の削除...........................................................................................................140

7.9.11 指定 Host に関する Host Connection の全削除 ..........................................................................142

7.9.12 指定 Host に関する Host Connection 情報の取得.......................................................................143

7.9.13 指定 Host に関する Host Connection の更新 .............................................................................146

7.9.14 指定 Volume に関する Host Connection 情報の取得 ..................................................................148

目次


はじめに

本書は、ストレージ管理クライアントソフトウェアなどから RESTful API を使用して、FUJITSU StorageETERNUS AF S3 series オールフラッシュアレイ, ETERNUS DX S5 series, ETERNUS DX 8100 S4/DX8900 S4ハイブリッドストレージシステムを設定および管理する方法について説明しています。

Copyright 2020 FUJITSU LIMITED初版

2020 年 10 月

登録商標本製品に関連する他社商標については、以下のサイトを参照してください。https://www.fujitsu.com/jp/products/computing/storage/trademark/

本書の読み方

対象読者

本書は、ETERNUS AF/DX および RESTful API の基本的な機能の知識を持ったユーザーを対象としています。本書は、RESTful API を使用して開発するアプリケーション・プログラマー向けに書かれています。

関連マニュアル

本書の最新版や本装置に関連する最新の情報は、以下のサイトで公開されています。https://www.fujitsu.com/jp/products/computing/storage/manual/必要に応じて以下のマニュアルを参照してください。• 製品概説

• 設計ガイド

• 設置計画ガイド

• 運用ガイド（基本編）

• 構築／運用ガイド（NAS 編）

• 構築ガイド（サーバ接続編）

• ETERNUS Web GUI ユーザーズガイド

• ETERNUS CLI ユーザーズガイド

• ETERNUS SF KM

• ETERNUS SF Storage Cruiser 運用ガイド

• ETERNUS vCenter Plug-in ユーザーズガイド


https://www.fujitsu.com/jp/products/computing/storage/trademark/https://www.fujitsu.com/jp/products/computing/storage/manual/

本書の表記について

製品名モデル名オールフラッシュアレイ ETERNUS AF150 S3/AF250 S3/AF650 S3ハイブリッドストレージシステム ETERNUS DX60 S5/DX100 S5/DX200 S5

ETERNUS DX500 S5/DX600 S5/DX900 S5ETERNUS DX8100 S4/DX8900 S4

本文中の記号

本文中では、以下の記号を使用しています。

お使いになるときに注意していただきたいことを記述しています。必ずお読みください。

本文を補足する内容や、参考情報を記述しています。

はじめに


第 1 章概要本章では、ETERNUS AF/DX RESTful API の概要について説明します。

1.1 概要RESTful API とは、REST（REpresentational State Transfer）の設計原則に従って策定されたインターフェースであり、ETERNUS AF/DX への IP 接続が可能な任意の管理クライアントソフトウェアからアクセスできます。API へのアクセスは、ポート 5665 を使用した HTTPS 通信で行います。ファームウェア版数 V11L40 以降でのみ使用可能です。RESTful API の主な機能は以下のとおりです。• 装置構成表示

ドライブ、ボリュームなどの装置構成を通知します。• 装置構成変更

シン・プロビジョニングプール、ボリュームの作成／削除およびホスト・コネクションの作成／削除などを行います。

1.2 RESTful API へのアクセスRESTful API はマスタコントローラーモジュールの管理 LAN ポートを利用します。RESTful API クライアント（管理クライアントソフトウェア側）から RESTful API へのアクセスは、HTTPS 通信

（5665 ポート）で行います。認証局発行証明書として Web GUI の SSL 証明書を使用します。同時接続可能数は 64 です。接続要求が同時接続可能数を超える場合は、HTTP ステータスコード 503 で応答します。

1.3 RESTful API 設定RESTful API を使用するためには、RESTful API 設定を有効にする必要があります。RESTful API 設定の変更方法については、ETERNUS Web GUI または ETERNUS CLI のユーザーズガイドを参照してください。

1.4 Firewall 設定RESTful API では HTTPS 通信にポート 5665 を使用します。ファームウェア版数 V11L30 以前から V11L40 以降へファームウェアアップデートを行った場合は、ポート 5665 は無効状態となっています。RESTful API を使用する場合は、Firewall 設定でポートを有効状態にしてください。Firewall 設定の詳細については、ETERNUSWeb GUI または ETERNUS CLI のユーザーズガイドを参照してください。


第 2 章権限本章では、クライアントソフトウェアから RESTful API に接続するための権限について説明します。RESTful API を使用するには、操作に必要な権限を持つユーザーが発行したトークンを指定する必要があります。ユーザー権限は、ETERNUS Web GUI や ETERNUS CLI と同じです。ユーザー権限については、ETERNUS Web GUI ユーザーズガイドまたは ETERNUS CLI ユーザーズガイドを参照してください。


第 3 章制限事項本章では、API コマンド使用上の制限事項について説明します。

3.1 メインフレーム機能メインフレーム管理に関連する機能は RESTful API では未サポートです。GS 接続機構ライセンスが有効な装置では、RESTful API 設定を有効化することはできません。

3.2 Unified 機能Unified 管理に関連する機能は RESTful API では未サポートです。ただし、Unified 装置における SAN 側の管理に RESTful API を使用することはできます。

3.3 アドバンスト・コピー機能アドバンスト・コピー管理に関連する機能は RESTful API では未サポートです。

3.4 ボリュームタイプ作成可能なボリュームの種類は、Standard ボリュームおよびシン・プロビジョニングボリュームです。WSV、SDV、FTV など、それ以外のボリュームは作成できません。ただし、一部の操作は可能です。例えば、WSV、FTV、SDV、SDPV の情報取得は、GET /volume により可能です。詳細については、各コマンドの説明を参照してください。

3.5 ホスト・コネクションRESTful API では、ホストに対してボリュームへのアクセス許可を制御する機能が使用できますが、ETERNUSWeb GUI または ETERNUS CLI によって構成された ETERNUS AF/DX を管理する場合、整合性を保持するためにいくつかの操作／表示が制限されます。

3.5.1 ホストタイプ

ホストの登録／変更／削除／表示や、ホスト・コネクションの作成／削除／表示が可能なホストの種類は FC および iSCSI です。それ以外のホストタイプは管理できません。

3.5.2 グループ化による設定

ETERNUS Web GUI または ETERNUS CLI で作成されたグループに属するリソースを操作／表示することは可能ですが、以下の操作はできません。• ホストグループやポートグループ、LUN グループを使用したホスト・コネクション作成

• ホストグループに属しているホストを指定した、ホストレスポンス設定の変更

• 複数の LUN グループにアフィニティ設定されているホストを指定した、ホスト・コネクションの作成・削除


3.5.3 任意のホストとのコネクション設定

特定のボリュームに対して、任意のホストからのアクセスを許可するような設定はできません。アクセスを許可するホストを必ず指定する必要があります。

第 3 章制限事項3.5 ホスト・コネクション


第 4 章インターフェースデータには以下の種類があります。• HTTP メソッド

• HTTP クライアントヘッダー

• URI

• ボディHTTP メソッドと URI、HTTP のバージョンを合わせてリクエストラインと呼びます。リクエストラインの指定可能最大長は 1,280byte です。これを超えるリクエストラインを送信した場合は HTTP ステータスコード 413 でエラー終了します。

備考• RESTful API で使用する文字コードは UTF-8 です。指定可能文字については RFC3986 を参照してくだ

さい。• 各 API の Query Parameters の説明に指定可能数の上限が記載されていますが、リクエストラインの全

長が 1,280byte を超える場合は、上限数まで指定できません。

4.1 HTTP メソッド以下の HTTP メソッドをサポートしています。• GET

既存のオブジェクトを取得します。• POST

新しいオブジェクトを作成します。• PATCH

既存のオブジェクトを変更します。• DELETE

既存のオブジェクトを削除します。

4.2 HTTP クライアント・ヘッダー以下のクライアント・ヘッダーをサポートしています。• Content-Type

本体データ(ボディ)は JSON 形式で送信します。ボディを送信する場合には application/json を設定してください。

• AuthorizationBearer 認証を使用します。POST /session で取得した Token を Authorization:Bearer と指定してください。

4.3 URIURI は Path と Query からなります。


URI の Syntax は以下となります。

?=&=...

Query で指定するパラメーター名 (fields など) は英大文字小文字を区別しますが、パラメーター値は英大文字小文字を区別しません。ただし、パラメーター値が Boolean の場合、true/false は小文字のみ指定可能です。パラメーター名の指定に誤りがある場合、HTTP ステータスコード 400 でエラー終了します。

注意パラメーターの値が RFC3986 に定められた予約文字を含む場合は、文字列をエンコードせずに指定してください。

備考コマンドで取得できる URI 情報には、Base Path (例: https://192.168.1.1:5665) を含みません。

4.3.1 表示する項目の絞り込み

GET による情報取得では、Query に fields オプションを指定することで、表示する項目を絞ることができます。fields に、表示したい項目を以下のように "," 区切りで指定してください。fields の指定がない場合、すべての項目を取得します。例)https://192.168.1.1:5665/api/v1/volume?fields=name,status

リソース ID ({リソース名}_id) は fields の指定有無にかかわらず応答します。リスト形式で応答される情報を抜き出して取得したい場合は、リスト内のパラメーター名を指定してください。例えば、GET /volume にてボリューム名のみを取得したい場合は、fields=volume_list.name ではなく、fields=name となります。レスポンスボディで応答されるパラメーター名は基本的にすべて fields で指定可能ですが、以下のパラメーター名を fields に指定することはできません。これらは fields の指定にかかわらず、応答条件を満たした場合に応答します。• 応答をサポートしていないパラメーター名。

• 以下のパラメーター名。- total_count

- list_count

- next_href

• API コマンド名となっているリソースのオブジェクト名 ({リソース名}_list) 。例えば、GET /tpp?fields=tpp_list は指定不可です。一方、GET /tpp?fields=raidgroup_list は指定可能です。

4.3.2 表示するリソースの絞り込み

GET による情報取得では、Query に条件を指定することで、表示するリソースを絞ることができます。複数の条件を指定する場合は、以下のように "&" 区切りで指定します。指定可能な条件の詳細については、各コマンドの Parameters を参照してください。例)https://192.168.1.1:5665/api/v1/volume?status=Normal&type=TPV,Standard

第 4 章インターフェース4.3 URI


4.4 ボディリクエストボディおよびレスポンスボディともに、JSON 形式となります。

4.4.1 リクエストボディ

リクエストボディ(入力)の最大サイズは 120KB です。これを超えるリクエストボディを送信した場合は HTTP ステータスコード 413 でエラー終了します。リクエストボディ内で指定するパラメーター名については、英大文字小文字を区別しますが、パラメーター値は英大文字小文字を区別しません。ただし、Friendly Name などユーザーが登録する文字列については英大文字小文字を区別し、指定された文字列の大文字・小文字がそのまま装置に登録されます。また、パラメーター値が Boolean の場合、true/false は小文字のみ指定可能です。

4.4.2 レスポンスボディ

レスポンスボディ(出力)の最大サイズは 1MB です。GET コマンドにおいて出力情報量がこれを超える場合は、途中までの情報を応答します。続きの情報を取得するためには、レスポンスデータにある next_href に記載された URI に Base Path を付与して再度発行してください。詳細は、各コマンドの Responses にある next_href の説明を参照してください。

4.5 応答

4.5.1 成功時の応答

以下に、成功時の HTTP ステータスコードを示します。

コード説明200 リクエストが適切に処理されたことを示します。202 非同期処理のリクエストの受け付けが完了したことを示します。

4.5.2 エラー時の応答

以下に、エラー時の一般的な HTTP ステータスコードを示します。

コード説明400 URI またはリクエストボディが不正であることを示します。401 認証に失敗したことを示します。403 操作を実行するために必要な権限がないことを示します。404 Path で指定したリソースが見つからないことを示します。409 Path で指定したリソースに対して、矛盾した状態や不可能な状態への変更を要求したことを示します。

例：作成済みのリソースと同じ名前のリソースを作成しようとした。413 リクエストラインの長さ、またはリクエストボディのサイズが指定可能な範囲を超えていることを示します。500 内部エラーが発生したことを示します。503 ストレージ装置または操作対象のリソースがビジー状態でリクエストを受け付けられないことを示します。

このステータスコードが返る場合は、再度リクエストを実行してください。

第 4 章インターフェース4.4 ボディ


また、レスポンスボディには以下のエラー詳細情報が格納されます。

項目説明error_code エラーメッセージ番号で、4 桁の固定番号です。

ETERNUS CLI で応答されるエラーメッセージ番号と同じ番号を使用しています。エラーへの対処方法については、ETERNUS CLI ユーザーズガイドの付録 A「エラーメッセージ/エラーコード」もあわせて参照してください。

message エラーメッセージです。フォーマットは以下となります。"Description (Factor)"Description には、エラーメッセージ番号に応じた説明文が表示されます。Factor には、エラーの要因となったパラメーターが表示されます。

internal_code 内部エラーコードです。

第 4 章インターフェース4.5 応答


第 5 章ログインとログアウト

5.1 ログインRESTful API へのログインは POST /session で行います。POST /session で取得した Token を API コマンド発行時の Authorization Header に指定してください。作成したセッションの有効時間は 30 分です。API コマンドを発行しても延長されません。有効期限が切れて無効となった Token を使用した場合、その API コマンドは HTTP ステータスコード 401 で応答します。その場合は再度ログインを行い、Token を新規で取得してください。

5.2 ログアウトRESTful API からのログアウトは DELETE /session で行います。ログアウト後、Token は無効になります。


第 6 章ジョブ管理POST/PATCH/DELETE メソッドの API コマンド処理は、原則として非同期で実行されます。コマンドを受け付けると、非同期で実施する処理を装置にジョブとして登録し、登録したジョブの href を応答します。ジョブの進行状況は、GET /job でチェックできます。詳細は、「7.2.1 全 Job 情報の取得」(21 ページ)の説明を参照してください。登録されたジョブはステータスが Success、Error、または Canceled となってから 30 分後に自動で削除されます。

注意装置のジョブ登録可能数は 512 です。これを超える場合、HTTP ステータスコード 503 で応答します。そのため、不要となったジョブはすぐに DELETE /job で削除するようにしてください。


第 7 章コマンドリファレンス本章では、各 API コマンドについて説明します。

7.1 セッション

7.1.1 Session の作成

POST /session

■ 概要説明Session を作成します。API コマンドを発行する場合は、本コマンドにて取得した Token を Authorization Header に指定してください。

注意作成した Session が有効な時間は 30 分です。API コマンドを発行しても延長されません。user_name または password が間違っている、またはパスワード期限切れの場合に HTTP ステータスコード 401 が応答されます。

■ リクエスト例• User="USERNAME"、Password="PASSWORD"の場合の Session 作成例です。

$ curl -H "Accept:application/json" -X POST "https://192.168.1.1:5665/api/v1/session"-d'{"user_name":"USERNAME","password":"PASSWORD"}'

■ レスポンス例{ "session_id":100001, "token":"g17e4umvwYoHuhkG7yCSee..", "lifetime":1800}

Token を取得できたら以降は API コマンドの Authorization Header に Token を設定してコマンドを発行してください。以下は、curl コマンドを使用して上記の例で取得した Token を使用して、Session 情報取得を行う例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/session/100001"

■ ParametersREQUEST BODY

user_name(required)

stringUser Name。


password(required)

stringPassword。

■ Responses正常に作成できた場合、HTTP ステータスコードが 200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

session_id integerSession ID。

token stringToken。ユーザーを特定するための認証情報です。API コマンドを発行する場合は、Authorization Header にこの Token を指定してください。

lifetime integerSession が有効な残り時間。単位は秒です。この Token(Session)が有効な残り時間を応答します。

第 7 章コマンドリファレンス7.1 セッション


7.1.2 Session の削除

DELETE /session/{session_id}

■ 概要説明指定した Session ID の Session を削除します。削除後はその Session で使用していた Token は使用できません。Token に対応した Session のみ削除可能です。

■ リクエスト例• Session ID 1000001 を削除する場合の例です。

curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X DELETE "https://192.168.1.1:5665/api/v1/session/1000001"

■ ParametersPATH PARAMETERS

session_id(required)

integerSession ID。

■ Responses正常に削除できた場合、HTTP ステータスコードが 200 (OK)となります。



7.1.3 Session 情報の取得

GET /session/{session_id}

■ 概要説明Session 情報の取得。指定した Session ID についての情報を取得します。API コマンド発行時に設定した Token に対応する Session の情報のみ取得可能です。

■ リクエスト例• Session ID 1000001 について、Session ID と lifetime を取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/session/1000001?fields=lifetime"

■ レスポンス例{ "session_id": 1000001, "user_name": "USER#1", "lifetime": 300}


session_id(required)

integerSession ID。

QUERY PARAMETERS

fields Array of strings表示したい Parameter。指定した Parameter 名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、「4.3.1 表示する項目の絞り込み」(12 ページ)を参照してください。

■ Responses正常に取得できた場合、HTTP ステータスコードが 200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

session_id integerSession ID。

user_name stringこの Session を作成した User 名。

lifetime integerSession が有効な残り時間。単位は秒です。この Token(Session)が有効な残り時間を応答します。



7.2 ジョブ

7.2.1 全 Job 情報の取得

GET /job

■ 概要説明自 User の Job についての情報を取得します。

注意Job 情報は Job 状態が Success、Error、Canceled となってから 30 分間保持されますが、その後自動で削除されます。

■ リクエスト例• Status が Success である Job について、Job ID と Status を取得する場合の例です。

$ curl -H "Accept:application/json"-H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.."-X GET "https://192.168.1.1:5665/api/v1/job?status=Success&fields=status"

■ レスポンス例{ "total_count": 512, "list_count": 1, "job_list": [ { "job_id": 8192001, "job_href": "/api/v1/job/8192001", "description": "POST /api/v1/tpp {"name" : "tpp_raid5","level" : "RAID5",...}", "status": "Success", "created_time": "2020-01-06T12:20:00Z", "modified_time": "2020-01-06T12:30:00Z", "resource_href_list": [ "/api/v1/tpp/0" ], "operation_list": [ { "result": "Succeeded", "operation": "create thin-pro-pool -rg-mode manual -attribute nearline -name tpp#0 -level 1 -disks 0004,0005" }, { "result": "Succeeded", "operation": "expand thin-pro-pool -rg-mode manual -pool-name tpp#0 -disks 006,007" } ] } ]}

第 7 章コマンドリファレンス7.2 ジョブ


■ ParametersQUERY PARAMETERS



job_id Array of integersJob ID。情報を取得したい Job ID を指定します。入力条件：• 512 個まで指定可能です。

status Array of stringsJob Status。情報を取得したい Status を指定します。入力条件：• 5 個まで指定可能です。

max_records integer情報を取得したいリソースの最大数。応答する情報数を制限したい場合に指定してください。入力条件• 指定可能な範囲は 1～512 です。

last_get_id integer続きの情報を取得するためのリソースの識別子。一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_href が返却されます。last_get_id は next_href に付与される、続きの情報を取得するための情報です。


RESPONSE BODY

total_count integer装置に存在する Resource の総数。フィルタリングしている場合は、条件に合致する Resource の総数です。

list_count integer応答する List の個数。

job_list Array of objectsGET /job/job_id で取得できる情報を、list_count 数分出力します。詳細は、「7.2.3 Job 情報の取得」(24ページ)の「Responses」を参照してください。

next_href string続きの情報取得するための Link。一度にすべての情報を応答しきることができなかった場合に限り応答します。例えば、max_records で指定した個数以上に応答条件に合致する Resource が存在する場合などに応答します。



7.2.2 Job 情報の削除

DELETE /job/{job_id}

■ 概要説明指定した自 User の Job 情報を削除します。自 User の Job のうち、Status が Success / Error / Canceled である Job 情報の削除が可能です。

■ リクエスト例• Job ID 8192001 を削除する場合の例です。

curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X DELETE "https://192.168.1.1:5665/api/v1/job/8192001"


job_id(required)

integerJob ID。

■ Responses正常に削除できた場合、HTTP ステータスコードが 200 (OK)となります。



7.2.3 Job 情報の取得

GET /job/{job_id}

■ 概要説明指定された job_id の Job についての情報を取得します。

注意ほかの User が作成した Job 情報を取得することはできません。Job ID で指定した Job が存在しても、自身が作成した Job でなければ HTTP ステータスコード 404 で応答します。

■ リクエスト例• Job ID 8192001 について、Job ID と Status を取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/job/8192001?fields=status"

■ レスポンス例{ "job_id": 8192001, "job_href": "/api/v1/job/8192001", "description": "POST /api/v1/tpp {"name" : "tpp_raid5","level" : "RAID5",...}", "status": "Success", "created_time": "2020-01-06T12:20:00Z", "modified_time": "2020-01-06T12:30:00Z", "resource_href_list": [ "/api/v1/tpp/0" ], "operation_list": [ { "result": "Succeeded", "operation": "create thin-pro-pool -rg-mode manual -attribute nearline -name tpp#0 -level 1 -disks 0004,0005" }, { "result": "Succeeded", "operation": "expand thin-pro-pool -rg-mode manual -pool-name tpp#0 -disks 006,007" } ]}


job_id(required)

integerJob ID。



QUERY PARAMETERS




RESPONSE BODY

job_id integerJob ID。

job_href stringJob の Resource への Link。

description stringJob の概要。

status stringJob の状態。

項目説明Queued キューイングされた Job です。Running 実行中の Job です。Success 正常終了した Job です。Error 異常終了した Job です。Canceled Cancel された Job です。

created_time stringJob 作成時間。Job が作成された日時(ISO8601 拡張形式)を応答します。Format は以下です。タイムゾーンは UTC です。YYYY-MM-DDThh:mm:ssZ

modified_time stringJob 状態変更時間。Job の Status が変わったときの日時(ISO8601 拡張形式)を応答します。Format は以下です。タイムゾーンは UTC です。YYYY-MM-DDThh:mm:ssZ

resource_href_list Array of strings作成された Resource への Link。Resource が作成された場合に、その Resource への Link を応答します。本 Parameter は以下の条件をすべて満たした場合に限り応答します。• Job を作成した API の Method が"POST"で、URI を持つ Resource を作成した場合• Job の Status が Success であること

error_code stringエラーコード。Status が Error となった場合に応答します。Job が失敗したときのエラーコードを応答します。エラーの詳細、対応方法については error_message と ETERNUS CLI ユーザーズガイドの付録 A「エラーメッセージ/エラーコード」を参照ください。



internal_code stringError Internal Code。Status が Error となった場合に応答します。開発者向けの情報です。

error_message stringError Message。Status が Error となった場合に応答します。エラーの詳細を応答します。Format は以下です。"Description(Factor)"• Description- error_code に対応する Error 内容の説明文です。• Factor- Error の要因となった Parameter。Description を参考にして Parameter の設定を見直してくだ

さい。operation_list object

Job で実行される処理一覧。Job の Status が Error となった場合に限り応答します。

result stringOperation の結果。

項目説明Succeeded 成功Failed 失敗Unexecuted 未実行

operation stringOperation の詳細。



7.2.4 Job のキャンセル

POST /job/{job_id}/cancel

■ 概要説明指定した自 User の Job を Cancel します。自 User が登録した Job のうち、Status が Queued である Job の Cancel が可能です。

■ リクエスト例• Job ID 8192001 を Cancel する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/job/8192001/cancel"


job_id(required)

integerJob ID。

■ Responses正常にキャンセルできた場合、HTTP ステータスコードが 200 (OK)となります。



7.3 ストレージシステム

7.3.1 装置情報の取得

GET /storagesystem

■ 概要説明装置の情報を取得します。

■ リクエスト例• 装置のステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/storagesystem?fields=status"

■ レスポンス例{ "storage_system_name": "E500_003", "status": "Normal", "detail_status": "Normal", "model_name": "ET503SA", "serial_number": "000123456789", "wwn": "500000e0dc000000", "boxid": "00DXL#########ET06F21AUABCPJ000000######", "firmware_version": "V11L40-0000", "date": "2020-11-07T02:50:59Z", "is_write_through_mode": false, "is_thin_provisioning_enable": true, "maximum_pool_capacity": 512, "is_data_reduction_enable": true, "is_local_copy_available": true, "local_copy_license_type": "Full", "is_remote_copy_available": true, "remote_copy_license_type": "Full", "is_encryption_available": true, "is_exc_enable": true, "power_1min_avg": 460, "power_1hour_avg": 520}





第 7 章コマンドリファレンス7.3 ストレージシステム


RESPONSE BODY

storage_system_name string装置名。

status string装置の総合ステータス。状態表示の権限がある場合に応答します。

項目説明Normal 正常状態です。Maintenance 保守状態です。Warning 予防保守が必要な状態です。Error 異常が発生し、保守が必要な状態です。

detail_status string装置の詳細ステータス。状態表示の権限がある場合に応答します。

項目説明Normal 装置は正常状態です。Maintenance 保守作業中の部品があります。または、リビルド／コピーバックを実行中です。Change_Controlling_CM 担当 CM の変更が必要です。Pinned_Data PIN データが発生しました。Warning 予防保守が必要な部品があります。または、不良セクターが発生しました。Error 障害が発生した部品があります。Not_Ready 装置は起動時または電源切断時に故障を検出しました。ホストからの I/O が正

常に受け付けられません。Subsystem_Down 装置は故障状態です。ホストからの I/O が正常に受け付けられません。

model_name string装置のモデル名。状態表示または保守作業の権限がある場合に応答します。

serial_number string装置の製造番号。状態表示または保守作業の権限がある場合に応答します。

wwn string装置の WWN。状態表示または保守作業の権限がある場合に応答します。

boxid string装置の Box ID。状態表示または保守作業の権限がある場合に応答します。

firmware_version string稼働中のコントローラーファームウェアの総合版数。状態表示または保守作業の権限がある場合に応答します。

date string装置の日付および時刻(ISO8601 拡張形式)。権限によらず必ず応答します。Format は以下です。タイムゾーンは UTC です。YYYY-MM-DDThh:mm:ssZ

is_write_through_mode booleanCache の動作状態。状態表示または保守作業の権限がある場合に応答します。true の場合、ホストからの Write 要求に対し、キャッシュ領域だけではなくドライブへの書き込み完了時に

「Write 完了」とするモードです。



is_thin_provisioning_enable

boolean装置の Thin Provisioning 設定。状態表示、RAID グループ設定、または装置設定の権限がある場合に応答します。true の場合、Thin Provisioning 機能が有効です。

maximum_pool_capacity

integer装置の最大プール容量。状態表示、RAID グループ設定、または装置設定の権限がある場合に応答します。単位は TB です。

is_data_reduction_enable

boolean装置の Data Reduction 設定。状態表示、装置設定、または保守作業の権限がある場合に応答します。true の場合、Data Reduction 機能が有効です。

is_local_copy_available boolean装置の Local Advanced Copy 使用可否。状態表示、アドバンスト・コピー設定、コピーセッション設定、または装置設定の権限がある場合に応答します。true の場合、Local Advanced Copy 機能が使用可能です。

local_copy_license_type string装置の Local Advanced Copy ライセンスの種別。状態表示、アドバンスト・コピー設定、コピーセッション設定、または装置設定の権限がある場合に応答します。is_local_copy_available が false の場合は、応答しません。

項目説明Free フリーライセンスが登録されています。Trial トライアルライセンスが登録されています。Full 有償ライセンスが登録されています。すべての Advanced Copy 機能を使用できます。

is_remote_copy_available

boolean装置の Remote Advanced Copy 使用可否。状態表示、アドバンスト・コピー設定、コピーセッション設定、または装置設定の権限がある場合に応答します。true の場合、Remote Advanced Copy 機能が使用可能です。

remote_copy_license_type

string装置の Remote Advanced Copy ライセンスの種別。状態表示、アドバンスト・コピー設定、コピーセッション設定、または装置設定の権限がある場合に応答します。is_remote_copy_available が false の場合は、応答しません。

項目説明Trial トライアルライセンスが登録されています。Full 有償ライセンスが登録されています。すべての Advanced Copy 機能を使用できます。

is_encryption_available booleanCM による暗号化機能の使用可否。状態表示、アドバンスト・コピー設定、装置設定、セキュリティ設定、または保守作業の権限がある場合に応答します。true の場合、CM による暗号化機能が使用可能です。

is_exc_enable boolean装置の Extreme Cache または Extreme Cache Pool 設定。状態表示、ボリューム登録・変更、または装置設定の権限がある場合に応答します。true の場合、Extreme Cache または Extreme Cache Pool 機能が有効です。

power_1min_avg integer直近 1 分の平均消費電力。状態表示の権限がある場合に応答します。単位は W です。



power_1hour_avg integer直近 1 時間の平均消費電力。状態表示の権限がある場合に応答します。単位は W です。



7.4 コンポーネント

7.4.1 Frontend Enclosure 情報の取得

GET /fe

■ 概要説明Frontend Enclosure の情報を取得します。

■ リクエスト例• Frontend Enclosure のステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/fe?fields=status"

■ レスポンス例{ "status": "Normal", "detail_status": "Normal", "frt0_status": "Normal", "frt1_status": "Normal", "frt2_status": "Normal", "frt3_status": "Normal", "svc0_status": "Normal", "svc1_status": "Normal", "fan0_status": "Normal", "fan1_status": "Normal", "fan2_status": "Normal", "fan3_status": "Normal", "psu0_status": "Normal", "psu1_status": "Normal", "psu2_status": "Normal", "psu3_status": "Normal", "temperature_status": "Normal", "temperature": "25" "power_1min_avg": 255, "power_1hour_avg": 310}





第 7 章コマンドリファレンス7.4 コンポーネント


RESPONSE BODY

status stringステータス。

項目説明Normal 正常状態です。Unused 実装されていますが、未使用状態です。Maintenance 保守状態です。Warning 予防保守が必要な状態です。Error 異常が発生し、保守が必要な状態です。

detail_status string詳細ステータス。

項目説明Normal 部品は正常状態です。Unconnected 内部に異常状態の部品があります。Undefined 実装されていますが、使用されていない部品があります。Undefined-Error_Parts_Exist 未使用で異常状態の部品があります。Normal-Unused_Parts_Exist 内部に使用されていない部品があります。Maintenance 部品は保守作業中です。Warning 予防保守が必要な部品があります。Error 部品に障害が発生しました。

frt0_status stringステータス。










svc0_status stringステータス。


svc1_status stringステータス。


fan0_status stringステータス。










psu0_status stringステータス。










temperature_status stringステータス。


temperature string環境温度。単位は℃です。センサー故障で情報取得不可の場合は 0 と表示します。

power_1min_avg integer直近 1 分の平均消費電力。単位は W です。

power_1hour_avg integer直近 1 時間の平均消費電力。単位は W です。



7.4.2 全 Controller Enclosure 情報の取得

GET /ce

■ 概要説明Controller Enclosure の情報を取得します。ce_id で昇順に表示します。

■ リクエスト例• Controller Enclosure の CE ID とステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/ce?fields=status"

■ レスポンス例{ "total_count": 512, "list_count": 1, "ce_list": [ { "ce_id": "1", "ce_href": "/api/v1/ce/1", "status": "Normal", "detail_status": "Normal", "temperature_status": "Normal", "temperature": "25" "power_1min_avg": 255, "power_1hour_avg": 310, "cm0_status": "Normal", "cm1_status": "Normal", "bbu0_status": "Normal", "bbu0_charge_rate": 80, "bbu0_expiration_date": "2099-12", "bbu1_status": "Normal", "bbu1_charge_rate": 80, "bbu1_expiration_date": "2099-12", "psu0_status": "Normal", "psu1_status": "Normal", "bud0_status": "Normal", "bud1_status": "Normal", "bud2_status": "Normal", "bud3_status": "Normal", "drive_href_list": [ "/api/v1/drive/0000", "/api/v1/drive/0001", "/api/v1/drive/0002", "/api/v1/drive/0003" ] } ]}






ce_id Array of stringsCE ID。情報を取得したい Controller Enclosure の ID を指定します。入力条件：• 12 個まで指定可能です。

status Array of stringsステータス。情報を取得したいリソースのステータスを指定します。


入力条件：• 5 個まで指定可能です。


RESPONSE BODY



ce_list Array of objectsGET /ce/ce_id で取得できる情報を、list_count 数分出力します。詳細は、「7.4.3 Controller Enclosure 情報の取得」(39 ページ)の「Responses」を参照してください。



7.4.3 Controller Enclosure 情報の取得

GET /ce/{ce_id}

■ 概要説明Controller Enclosure の情報を取得します。

■ リクエスト例• Contoroller Enclosure ID 2 について、CE ID とステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/ce/2?fields=status"

■ レスポンス例{ "ce_id": "1", "ce_href": "/api/v1/ce/1", "status": "Normal", "detail_status": "Normal", "temperature_status": "Normal", "temperature": "25", "power_1min_avg": 255, "power_1hour_avg": 310, "cm0_status": "Normal", "cm1_status": "Normal", "bbu0_status": "Normal", "bbu0_charge_rate": 80, "bbu0_expiration_date": "2099-12", "bbu1_status": "Normal", "bbu1_charge_rate": 80, "bbu1_expiration_date": "2099-12", "psu0_status": "Normal", "psu1_status": "Normal", "bud0_status": "Normal", "bud1_status": "Normal", "bud2_status": "Normal", "bud3_status": "Normal", "drive_href_list": [ "/api/v1/drive/0000", "/api/v1/drive/0001", "/api/v1/drive/0002", "/api/v1/drive/0003" ]}


ce_id(required)

stringCE-ID (0～b)。



QUERY PARAMETERS




RESPONSE BODY

ce_id stringController Enclosure ID。

ce_href stringController Enclosure の Resource への Link。



detail_status string詳細ステータス。

項目説明Normal 部品は正常状態です。Unconnected 内部に異常状態の部品があります。Undefined 実装されていますが、使用されていない部品があります。Undefined-Error_Parts_Exist 未使用で異常状態の部品があります。Normal-Unused_Parts_Exist 内部に使用されていない部品があります。Maintenance 部品は保守作業中です。Warning 予防保守が必要な部品があります。Error 部品に障害が発生しました。

temperature_status stringステータス。


temperature string環境温度。単位は℃です。センサー故障で情報取得不可の場合は 0 と表示します。



power_1min_avg integer直近 1 分の平均消費電力。単位は W です。

power_1hour_avg integer直近 1 時間の平均消費電力。単位は W です。

cm0_status stringステータス。


cm1_status stringステータス。


bbu0_status stringステータス。


bbu0_charge_rate integerBBU の充電率。単位は%です。充電率が 90%以上の場合、「100」と表示されます。

bbu0_expiration_date integerBBU の有効期限。Format は以下です。YYYY-MMYYYY：年 (西暦)MM：月 (01～12)

bbu1_status stringステータス。




bbu1_charge_rate integerBBU の充電率。単位は%です。充電率が 90%以上の場合、「100」と表示されます。

bbu1_expiration_date integerBBU の有効期限。Format は以下です。YYYY-MMYYYY：年 (西暦)MM：月 (01～12)





bud0_status stringステータス。










drive_href_list Array of stringsDrive の Link。当該 CE に搭載されている Drive への Link が返ります。



7.4.4 全 CA Port の情報の取得

GET /caport

■ 概要説明CA Port の情報を取得します。caport_id で昇順に表示します。

■ リクエスト例• FC CA Port の CA Port ID と Interface Type、ステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/caport?type=FC&fields=status,type"

■ レスポンス例{ "total_count": 512, "list_count": 1, "caport_list": [ { "caport_id": "0011", "caport_href": "/api/v1/caport/0011", "status": "Normal", "ce_id": 0, "cm_number": 0, "ca_number": 1, "port_number": 1, "type": "iSCSI", "max_speed": 1, "mode": "CA", "link_speed": 1, "is_host_affinity_disabled": false, "is_used_for_storage_cluster": false, "mac_address": "01:02:03:04:05:06", "iscsi_name": "iqn.2000-09.com.fujitsu:storage-system.eternus_dxl:000000", "iscsi_alias_name": "ALIAS00", "is_vlan_enable": true, "ip_address_list": [ { "ipv4_address": "192.168.1.1", "vlan_id": 0 }, { "link_local_ipv6_address": "fe80::290:ccff:fea4:3a49", "connect_ipv6_address": "2001:db8::8:800:200c:417a", "vlan_id": 1 } ] } ]}









caport_id Array of stringsCA Port ID。Format は以下です。wxyz• w - CE ID (0-b)• x - CM 番号 (0-1)• y - CA 番号 (0-3)• z - Port 番号 (0-3)入力条件：• 384 個まで指定可能です。

type Array of stringsCA Port の Interface Type。情報を取得したい Interface Type を指定します。

項目説明FC FC Interface PortiSCSI iSCSI Interface PortiSCSI_10GBASE-T iSCSI 10GBASE-T Interface PortSAS SAS Interface PortFCLINK Mainframe Interface PortOCLINK Mainframe Interface PortNAS NAS Interface Port




mode Array of stringsPort の動作 Mode。情報を取得したい Port の動作 Mode を指定します。

項目説明CA Host 接続 ModeRA REC 接続 ModeRFCF Remote File Copy Facility ModeInitiator FC Initiator ModeCARA Host 接続および REC 接続 Mode



last_get_id string続きの情報を取得するためのリソースの識別子。一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_href が返却されます。last_get_id は next_href に付与される、続きの情報を取得するための情報です。


RESPONSE BODY



caport_list Array of objectsGET /caport/caport_id で取得できる情報を、list_count 数分出力します。詳細は、「7.4.5 CA Port の情報の取得」(47 ページ)の「Responses」を参照してください。




7.4.5 CA Port の情報の取得

GET /caport/{caport_id}

■ 概要説明CA Port の情報を取得します。

■ リクエスト例• CA Port ID 0101 について、CA Port ID と Interface Type、ステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/caport/0101?fields=status,type"

■ レスポンス例{ "caport_id": "0011", "caport_href": "/api/v1/caport/0011", "status": "Normal", "ce_id": 0, "cm_number": 0, "ca_number": 1, "port_number": 1, "type": "iSCSI", "max_speed": 1, "mode": "CA", "link_speed": 1, "is_host_affinity_disabled": false, "is_used_for_storage_cluster": false, "mac_address": "01:02:03:04:05:06", "iscsi_name": "iqn.2000-09.com.fujitsu:storage-system.eternus_dxl:000000", "iscsi_alias_name": "ALIAS00", "is_vlan_enable": true, "ip_address_list": [ { "ipv4_address": "192.168.1.1", "vlan_id": 0 }, { "link_local_ipv6_address": "fe80::290:ccff:fea4:3a49", "connect_ipv6_address": "2001:db8::8:800:200c:417a", "vlan_id": 1 } ]}


caport_id(required)

stringCA Port ID。Format は以下です。wxyz• w -CE ID (0-b)• x - CM 番号 (0-1)• y - CA 番号 (0-3)• z - Port 番号 (0-3)



QUERY PARAMETERS




RESPONSE BODY

caport_id stringCA Port ID。Format は以下です。wxyz• w -CE ID (0-b)• x - CM 番号 (0-1)• y - CA 番号 (0-3)• z - Port 番号 (0-3)

caport_href stringCA Port への Link。



ce_id stringCA Port が実装される CE ID。

cm_number integerCA Port が実装される CM Number。

ca_number integerCA Port が実装される CA Slot Number。

port_number integerCA Port が実装される CA の Port Number。

type stringCA Port の Interface Type。

項目説明FC FC Interface PortiSCSI iSCSI Interface PortiSCSI_10GBASE-T iSCSI 10GBASE-T Interface PortSAS SAS Interface PortFCLINK Mainframe Interface PortOCLINK Mainframe Interface PortNAS NAS Interface Port



max_speed integerCA Port の最大転送速度。単位は Gbit/s です。最大転送速度が 1Gbit/s 未満の場合、0 を応答します。

mode stringPort の動作 Mode。

項目説明CA Host 接続 ModeRA REC 接続 ModeRFCF Remote File Copy Facility ModeInitiator FC Initiator ModeCARA Host 接続および REC 接続 Mode

link_speed integerPort の Link 状態。Type が FC または iSCSI の場合のみ応答します。単位は Gbit/s。Link Down している場合、0 を応答します。

is_host_affinity_disabled

booleanHost Affinity Mode が無効な Port かどうか。true の場合、Host Affinity Mode Disable となっており、Connection の設定ができません。Type が FC または iSCSI の場合、かつ Mode が CA、CARA の場合のみ応答します。

is_used_for_storage_cluster

booleanStorage Cluster 機能で使用されている Port かどうか。true の場合、Storage Cluster 機能で使用されており、Connection の設定ができません。Type が FC または iSCSI の場合、かつ Mode が CA、CARA の場合のみ応答します。

wwpn stringWorld Wide Port Name。Type が FC の場合のみ応答します。

mac_address stringPort の MAC Address。Type が iSCSI の場合のみ応答します。

iscsi_name stringiSCSI Name。Type が iSCSI の場合のみ応答します。

iscsi_alias_name stringiSCSI Alias Name。Type が iSCSI の場合のみ応答します。

is_vlan_enable booleanVLAN 機能が有効かどうか。true の場合、VLAN 機能が有効です。Type が iSCSI の場合のみ応答します。



ip_address_list Array of objectsIP Address と VLAN ID のリスト。Type が iSCSI の場合のみ応答します。VLAN 機能が無効の場合、VLAN ID は応答しません。IP Address が全く設定されていない場合は空の List を応答します。Array [

ipv4_address stringPort の IP Address(IPv4)。IPv4 を使用していない場合は応答しません。

link_local_ipv6_address

stringPort の Link Local IP Address(IPv6)。IPv6 を使用していない場合は応答しません。

connect_ipv6_address

stringPort の Connect IP Address(IPv6)。IPv6 を使用していない場合は応答しません。

vlan_id integerPort の VLAN ID。

]



7.4.6 全 Drive Enclosure 情報の取得

GET /de

■ 概要説明Drive Enclosure の情報を取得します。de_id で昇順に表示します。fem0_status/fem1_status/psu2_status/psu3_status は 60DE の場合のみ応答します。

■ リクエスト例• Drive Enclosure のステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/de?fields=status"

■ レスポンス例{ "total_count": 512, "list_count": 1, "de_list": [ { "de_id": "01", "de_href": "/api/v1/de/1", "status": "Normal", "detail_status": "Normal", "max_drive_count": 24, "temperature_status": "Normal", "temperature": "25" "power_1min_avg": 255, "power_1hour_avg": 310, "iom0_status": "Normal", "iom1_status": "Normal", "fem0_status": "Normal", "fem1_status": "Normal", "psu0_status": "Normal", "psu1_status": "Normal", "psu2_status": "Normal", "psu3_status": "Normal", "drive_href_list": [ "/api/v1/drive/0100", "/api/v1/drive/0101", "/api/v1/drive/0102", "/api/v1/drive/0103" ] } ]}






de_id Array of stringsDE ID。情報を取得したい Drive Enclosure の ID を指定します。入力条件：• 256 個まで指定可能です。





last_get_id string続きの情報を取得するためのリソースの識別子。一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_href が返却されます。last_get_id は next_href に付与される、続きの情報を取得するための情報です。

■ ResponsesRESPONSE BODY



de_list Array of objectsGET /de/de_id で取得できる情報を、list_count 数分出力します。詳細は、「7.4.7 Drive Enclosure 情報の取得」(53 ページ)の「Responses」を参照してください。




7.4.7 Drive Enclosure 情報の取得

GET /de/{de_id}

■ 概要説明Drive Enclosure の情報を取得します。fem0_status/fem1_status/psu2_status/psu3_status は 60DE の場合のみ応答します。

■ リクエスト例• Drive Enclosure ID 01 について、ステータスのみを取得する場合の例です。

$ curl -H "Accept:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/de/01?fields=status"

■ レスポンス例{ "de_id": "01", "de_href": "/api/v1/de/1", "status": "Normal", "detail_status": "Normal", "max_drive_count": 24, "temperature_status": "Normal", "temperature": "25" "power_1min_avg": 255, "power_1hour_avg": 310, "iom0_status": "Normal", "iom1_status": "Normal", "fem0_status": "Normal", "fem1_status": "Normal", "psu0_status": "Normal", "psu1_status": "Normal", "psu2_status": "Normal", "psu3_status": "Normal", "drive_href_list": [ "/api/v1/drive/0100", "/api/v1/drive/0101", "/api/v1/drive/0102", "/api/v1/drive/0103" ]}


de_id(required)

stringDE-ID (01～ff)。

QUERY PARAMETERS



eternus restful api リファレンス...restful...

Documents