付録A.3 REST APIサーバの通信モードを変更する
実行権限
ストレージ管理者(初期設定)
リクエストライン
PUT <ベースURL>/v1/<ストレージデバイスID>/services/communication-mode/actions/change/invoke
このAPIはPOSTメソッドでも実行できます。
リクエストメッセージ
- オブジェクトID
-
なし。
- クエリパラメータ
- なし。
- ボディ
-
通信モードをproxyModeに変更して、複数の中継サーバを指定する場合のコード例を次に示します。
{ "parameters": { "communicationModes": [ { "communicationMode": "proxyMode", "proxies": [ { "proxyIp": "192.0.2.101", "proxyPort": 1110 }, { "proxyIp": "192.0.2.102", "proxyPort": 1110 } ] } ] } }
複数の通信モードを指定する場合のコード例を次に示します。
{ "parameters": { "communicationModes": [ { "communicationMode": "proxyMode", "proxies": [ { "proxyIp": "192.0.2.101", "proxyPort": 2010 } ] }, { "communicationMode": "lanConnectionMode" } ] } }
属性
型
説明
communicationModes
object[]
(必須)通信モードの配列
最大で2つのcommunicationModeを指定できます。複数の通信モードを指定した場合、配列の先頭要素から順番に優先して通信をします。VSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合は、communicationModeに、fcConnectionModeまたはlanConnectionModeのどちらか1つを指定できます。各通信モードには次の属性を指定します。-
communicationMode(string)
(必須)通信モード
fcConnectionMode、proxyMode、lanConnectionModeのどれかを指定します。
REST APIサーバとストレージシステム間のSSL通信を有効にしている場合は、proxyModeは指定できません。
-
proxies(object[])
(任意)中継用サーバの配列
communicationModeにproxyModeを指定する場合は必ず指定します。最大で3つの中継用サーバを指定できます。複数の中継用サーバを指定した場合、配列の先頭要素から順番に優先して通信をします。-
proxyIp(string)
中継用サーバのIPアドレス
communicationModeにproxyModeを指定する場合は必ず指定します。
IPv4形式とIPv6形式のどちらでも指定できます。
-
proxyPort(int)
構成定義ファイルで指定したポート番号
communicationModeにproxyModeを指定する場合は必ず指定します。
-
-
レスポンスメッセージ
- ボディ
-
ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。
属性
説明
affectedResources
通信モードを変更したストレージシステムのURL
Actionテンプレート
なし。
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept: application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/836000123456/services/communication-mode/actions/change/invoke