12.3.7 リモート接続からリモートパスを削除する
実行権限
ストレージ管理者(リモートバックアップ管理)
リクエストライン
PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/remotepath-groups/<オブジェクトID>/actions/remove-remotepath/invoke
このAPIはPOSTメソッドでも実行できます。
リクエストメッセージ
- オブジェクトID
-
リモート接続の情報取得で取得したremotepathGroupIdの値を指定します。次のように属性値を連結した形式でも指定できます。
<remoteSerialNumber>,<remoteStorageTypeId>,<pathGroupId>
属性
型
説明
remoteSerialNumber
string
(必須)リモートストレージシステムのシリアル番号
remoteStorageTypeId
string
(必須)リモートストレージシステムのモデルを示すID
指定できる値を次に示します。
-
R7:Virtual Storage Platform
-
R8:VSP G1000、VSP G1500またはVSP F1500
- R9:VSP 5000 シリーズ
-
M7:HUS VM
-
M8:VSP E シリーズ、VSP Gx00 モデルまたはVSP Fx00 モデル
pathGroupId
int
(必須)パスグループID
-
- クエリパラメータ
- なし。
- ボディ
-
{ "parameters": { "localPortId": "CL1-A", "remotePortId": "CL2-B" } }
属性
型
説明
localPortId
string
(必須)ローカルストレージシステムのポート番号
remotePortId
string
(必須)リモートストレージシステムのポート番号
レスポンスメッセージ
- ボディ
-
ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。
属性
説明
affectedResources
リモート接続から削除したリモートパスのURL
Actionテンプレート
GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/remotepath-groups/<オブジェクトID>/actions/remove-remotepath
ステータスコード
この操作のリクエストに対するステータスコードの意味を次に示します。そのほかのステータスコードについては、HTTPステータスコードの説明を参照してください。
ステータスコード |
メッセージ |
説明 |
---|---|---|
412 |
Precondition Failed |
対象のリモート接続内のリモートパスが1本または設定されている最小の本数しかありません。 |
コード例
Actionテンプレートを取得する場合
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/remove-remotepath
Actionテンプレートを取得してリクエストを実行する場合
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/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/remove-remotepath/invoke