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

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

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

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

ボディ

なし。

レスポンスメッセージ

ボディ

{
    "data": [
        {
            "id": 500,
            "externalPaths": [
                {
                    "portId": "CL5-A",
                    "portProtocol": "FC",
                    "externalPortWwn": "50060e8012000c60"
                }
            ]
        },
        {
            "id": 600,
            "externalPaths": [
                {
                    "portId": "CL5-A",
                    "portProtocol": "FC",
                    "externalPortWwn": "50060e8012000c60"
                },
                {
                    "portId": "CL6-A",
                    "portProtocol": "FC",
                    "externalPortWwn": "50060e8012000c70"
                }
            ]
        }
    ],
    "count": 2,
    "totalCount": 2,
    "hasNext": false
}

属性	型	説明
id	int	外部パスグループID
externalPaths	object[]	外部パスグループに関連する外部パスの情報が、外部パスごとに出力されます。 portId（string） 外部接続用のポートID portProtocol（string） ポートのプロトコル FC iSCSI ポートの情報が取得できない場合、この属性は出力されません。 externalPortWwn（string） 外部ストレージシステムのポートのWWN ポートの情報が取得できない場合、または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