16.7　外部パスグループの情報を取得する

実行権限

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

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/external-path-groups

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

1回のリクエストで取得できる外部パスグループの情報は最大で200個です。201個以上の外部パスグループの情報を取得する場合は、countパラメータとstartIdパラメータを組み合わせて複数回に分けてAPIを実行してください。countパラメータを指定することで取得する外部パスグループの情報をフィルタリングすることもできます。

パラメータ	型	フィルタ条件
startId	int	（任意）取得を開始する外部パスグループのIDを0～63231の値で指定します。
count	int	（任意）取得する外部パスグループの情報の個数を1～200の値で指定します。 省略した場合、200が指定されたと見なされます。

ボディ

なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "id": 1235,
      "externalPaths": [
        {
          "portId": "CL5-A",
          "portProtocol": "FC",
          "externalPortWwn": "50060e8012000c60"
        }
      ]
    },
    {
      "id": 1200,
      "externalPaths": [
        {
          "portId": "CL1-B",
          "portProtocol": "iSCSI",
          "externalPortIpAddress": "10.1.9.122",
          "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d011",
          "externalTcpPortNumber": 3260,
          "virtualPortNumber": 1
        }
      ]
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

属性	型	説明
id	int	外部パスグループID
externalPaths	object[]	外部パスグループに関連する外部パスの情報が、外部パスごとに出力されます。 portId（string） 外部接続用のポートID portProtocol（string） ポートのプロトコル FC iSCSI ポートの情報が取得できない場合、この属性は出力されません。 externalPortWwn（string） 外部ストレージシステムのポートのWWN ポートの情報が取得できない場合、またはiSCSIポートのときには、この属性は出力されません。 externalPortIpAddress（string） 外部ストレージシステムのポートのIPアドレス IPv4またはIPv6形式で出力されます。 FCポートの場合、この属性は出力されません。 externalPortIscsiName（string） 外部ストレージシステムのポートのiSCSIターゲット名 FCポートの場合、この属性は出力されません。 externalTcpPortNumber（int） 外部ストレージシステムのポートのTCPポート番号 FCポートの場合、この属性は出力されません。 virtualPortNumber（int） 外部接続用のポートの仮想ポート番号 次の場合、この属性は出力されません。 FCポートの場合 iSCSIポートの場合で、仮想ポートが無効のとき

ステータスコード

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

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-path-groups