7.41　指定したホストへpingコマンドを送信する

メモ

このAPIは、HUS VMの場合は使用できません。

実行権限

ストレージ管理者（参照）

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/ports/＜オブジェクトID＞/actions/ping/invoke

このAPIはPOSTメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

ポートの情報取得で取得したportIdの値を指定します。

属性	型	説明
portId	string	（必須）ポート番号

クエリパラメータ

なし。

ボディ

{
  "parameters" : {
    "ipAddress" : "192.168.0.100"
  }
}

属性	型	説明
ipAddress	string	（必須）対象ホストのIPアドレス IPv4またはIPv6のIPアドレスを指定できます。

レスポンスメッセージ

ボディ

{
    "transmittedPackets": 5,
    "receivedPackets": 5
}

属性	型	説明
transmittedPackets	int	送信パケット数
receivedPackets	int	受信パケット数

Actionテンプレート

なし。

ステータスコード

この操作のリクエストに対するステータスコードの意味を次に示します。そのほかのステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/ports/CL1-A/actions/ping/invoke