4.5　リソースグループの一覧を取得する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

重要

ストレージシステムがVSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合にこのAPIを実行するときの注意事項を次に示します。

このAPIは、同時実行数に注意が必要です。詳細については、「リトライ処理の組み込み」を参照してください。
SVPと連携しない構成の場合、ストレージシステムの構成情報を更新するときに、Platform REST APIサーバでこのAPIが実行されます。その間、同時実行数に制限のあるAPIの実行に影響が出るおそれがあります。

実行権限

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

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/resource-groups

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

実行結果をフィルタリングする場合

パラメータ	型	フィルタ条件
lockStatus	string	（任意）リソースグループのロック状態 `Locked`：ロックされているリソースグループの情報を取得する `Unlocked`：ロックされていないリソースグループの情報を取得する

リソースグループ内の特定のリソースの種類だけを取得する場合

次のクエリパラメータを使用して必要なリソースの情報だけを取得することで、処理に掛かる時間を短くすることができます。

パラメータ	型	フィルタ条件
attributes	string	（任意）取得するリソースの種類指定した属性に対応するリソースの情報だけを取得します。複数指定する場合は、コンマで区切ります。 `lockStatus`パラメータと組み合わせて使うこともできます。 `ldevIds`：LDEV番号 `parityGroupIds`：パリティグループ番号 `externalParityGroupIds`：外部パリティグループ番号 `portIds`：ポート番号 `hostGroupIds`：ホストグループまたはiSCSIターゲットのオブジェクトID 指定を省略すると、上記のすべての属性の情報を取得します。そのほかの属性は、このクエリパラメータの指定に関係なく常に取得されます。

パラメータ

型

フィルタ条件

attributes

string

（任意）取得するリソースの種類

指定した属性に対応するリソースの情報だけを取得します。

複数指定する場合は、コンマで区切ります。

lockStatusパラメータと組み合わせて使うこともできます。

ldevIds：LDEV番号
parityGroupIds：パリティグループ番号
externalParityGroupIds：外部パリティグループ番号
portIds：ポート番号
hostGroupIds：ホストグループまたはiSCSIターゲットのオブジェクトID

指定を省略すると、上記のすべての属性の情報を取得します。

そのほかの属性は、このクエリパラメータの指定に関係なく常に取得されます。

クエリパラメータの指定例を場合ごとに次に示します。

ロックされているリソースグループのLDEV番号を取得する場合

?lockStatus=Locked&attributes=ldevIds

すべてのリソースグループのポート番号、およびホストグループまたはiSCSIターゲットのオブジェクトIDを取得する場合

?attributes=portIds,hostGroupIds

ボディ: なし。

レスポンスメッセージ

ボディ

Virtual Storage PlatformまたはUnified Storage VMの場合の出力例を次に示します。

{
  "data": [
    {
      "resourceGroupId": 0,
      "resourceGroupName": "meta_resource",
      "lockStatus": "Locked",
      "lockOwner": "devUser",
      "lockHost": "host01"
    },
    {
      "resourceGroupName": "sales_group_resource",
      "resourceGroupId": 1,
      "lockStatus": "Unlocked"
    }
  ]
}

VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合の出力例を次に示します。

{
  "data": [
    {
      "resourceGroupId": 4,
      "resourceGroupName": "devResourceGroup",
      "lockStatus": "Locked",
      "lockOwner": "devUser",
      "lockHost": "host01",
      "virtualStorageId": 0,
      "ldevIds": [
        12,
        13
      ],
      "parityGroupIds": [
        "1-1",
        "1-2"
      ],
      "externalParityGroupIds": [
        "1-5",
        "1-6"
      ],
      "portIds": [
        "CL1-A",
        "CL1-B"
      ],
      "hostGroupIds": [
        "CL1-A,4",
        "CL1-A,5",
        "CL1-A,6"
      ]
    },
    {
      "resourceGroupId": 5,
      "resourceGroupName": "sales_group_resource",
      "lockStatus": "Unlocked",
      "virtualStorageId": 0,
      "ldevIds": [
        32,
        33
      ],
      "parityGroupIds": [
        "2-1",
        "2-2"
      ],
      "externalParityGroupIds": [
        "1-7",
        "1-8"
      ],
      "portIds": [
        "CL3-A"
      ],
      "hostGroupIds": [
        "CL3-A,1",
        "CL3-A,2"
      ]
    }
  ]
}

attributesクエリパラメータを指定して、ポート番号およびホストグループまたはiSCSI ターゲットの情報だけを取得した場合の出力例を次に示します。

{
  "data": [
    {
      "resourceGroupId": 4,
      "resourceGroupName": "devResourceGroup",
      "lockStatus": "Locked",
      "lockOwner": "devUser",
      "lockHost": "host01",
      "virtualStorageId": 0,
      "portIds": [
        "CL1-A",
        "CL1-B"
      ],
      "hostGroupIds": [
        "CL1-A,4",
        "CL1-A,5",
        "CL1-A,6"
      ]
    },
    {
      "resourceGroupId": 5,
      "resourceGroupName": "sales_group_resource",
      "lockStatus": "Unlocked",
      "virtualStorageId": 0,
      "portIds": [
        "CL3-A"
      ],
      "hostGroupIds": [
        "CL3-A,1",
        "CL3-A,2"
      ]
    }
  ]
}

属性	型	説明
resourceGroupName	string	リソースグループ名
resourceGroupId	int	リソースグループID
lockStatus	string	リソースグループのロック状態 `Locked`：リソースグループがロックされている状態 `Unlocked`：リソースグループがロックされていない状態
selfLock	boolean	Authorizationヘッダに指定したセッションがリソースグループをロックしているかどうか `true`：指定したセッションがロックしている `false`：指定したセッション以外のセッションがロックしているリソースグループが、APIを実行したユーザと同じユーザが生成したセッションによってロックされている場合にだけ出力されます。
lockOwner	string	リソースグループをロックしているユーザID リソースグループがロックされている場合にだけ出力されます。
lockHost	string	リソースグループをロックしているIPアドレスまたはホスト名 REST APIからリソースグループをロックした場合、次のどれかのIP アドレスまたはホスト名が出力されます。 SVP GUM Configuration Manager REST APIサーバ Configuration Manager REST APIサーバの通信モードが`proxyMode`のときの中継用サーバリソースグループがロックされている場合にだけ出力されます。
lockSessionId	int	リソースグループをロックしているセッションID リソースグループがロックされている場合で、Administratorユーザグループ（ビルトイングループ）に属するユーザ（VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合）、またはmaintenanceユーザ（Virtual Storage PlatformまたはHUS VMの場合）がAPIを実行したときだけ出力されます。
virtualStorageId	int	リソースグループに対応している仮想ストレージマシンのID^※
ldevIds	int[]	LDEV番号^※
parityGroupIds	string[]	パリティグループ番号^※
externalParityGroupIds	string[]	外部パリティグループ番号^※
portIds	string[]	ポート番号^※
hostGroupIds	string[]	ホストグループまたはiSCSIターゲットのオブジェクトID^※

注※　VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合だけ取得できます。

ステータスコード

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

コード例

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/resource-groups

4.5 リソースグループの一覧を取得する

4.5　リソースグループの一覧を取得する