20.7　仮想LDEVの情報を取得する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

指定した条件で実行結果をフィルタリングしたり、仮想LDEVの詳細な情報を追加で取得したりできます。仮想LDEVの情報を取得するには、virtualSerialNumberパラメータを指定して、対象の仮想ストレージマシンを特定します。

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

取得する仮想LDEVの情報はデフォルトで最大100個です。countパラメータを指定することで最大16,384個まで取得できます。ldevOptionパラメータやpoolIdパラメータを指定して取得する仮想LDEVの情報が16,384個より多い場合、headVirtualLdevIdパラメータを使用して、取得対象の仮想LDEV番号が範囲に含まれるように指定してください。headVirtualLdevIdパラメータとcountパラメータの組み合わせで指定した範囲に含まれる仮想LDEVの数だけ情報が取得できます。

ヒント

フィルタリングされたリソースのうち、アクセス権限があるリソースだけが取得できます。

例えば、countパラメータに10を指定した場合、すべての仮想LDEVにアクセス権限があれば10個の仮想LDEVの情報が取得されます。特定の仮想LDEVにだけアクセス権限がある場合は、アクセス権限がある仮想LDEVの情報だけが取得されます。

重要: ストレージシステムがVSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、このAPIは、同時実行数に注意が必要です。詳細については、「リトライ処理の組み込み」を参照してください。

同時に指定できるクエリパラメータについては、指定できるクエリパラメータの組み合わせの表を参照してください。

パラメータ	型	フィルタ条件
virtualSerialNumber	string	（必須）仮想ストレージマシンのシリアル番号を指定します。指定した仮想ストレージマシン上の仮想LDEVの情報を、仮想LDEV番号の昇順で取得します。
headVirtualLdevId	int	（任意）情報取得を開始する仮想LDEV番号を10 進数で指定します。指定した仮想LDEV番号から昇順に情報を取得します。省略した場合、`0`が指定されたと見なされます。このパラメータを指定する場合、`virtualSerialNumber`パラメータも同時に指定してください。
count	int	（任意）取得する仮想LDEVの情報の範囲をIDで指定します。`1`～`16384`の値で指定します。省略した場合、100が指定されたと見なされます。
ldevOption	string	（任意）情報を取得する仮想LDEVの条件条件として入力できる値を次に示します。 `defined` 実装された仮想LDEVの情報を取得する `undefined` 未実装の仮想LDEVの情報を取得する `dpVolume` DPボリュームの情報を取得する `luMapped` LUパスが定義されている仮想LDEVの情報を取得する `luUnmapped` LUパスが定義されていない仮想LDEVの情報を取得する `externalVolume` 外部ボリュームの情報を取得する省略した場合、すべての種類の仮想LDEVの情報を取得します。
poolId	int	（任意）プール番号指定したプールに関連する仮想LDEVの情報を取得します。 `ldevOption`パラメータと組み合わせて指定すると、次の情報を取得します。 `ldevOption`パラメータに`dpVolume`を指定した場合：指定したプールに関連する、DPボリュームの情報を取得します。 `ldevOption`パラメータに`luMapped`を指定した場合：指定したプールに関連する、LUパスが定義されている仮想LDEVの情報を取得します。 `ldevOption`パラメータに`luUnmapped`を指定した場合：指定したプールに関連する、LUパスが定義されていない仮想LDEVの情報を取得します。 `ldevOption`パラメータを指定しないで、このパラメータを指定した場合、プールを構成するボリューム（プールボリューム）の情報を取得します。
resourceGroupId	int	（任意）情報を取得する仮想LDEVが属するリソースグループID
journalId	int	（任意）情報を取得する仮想LDEVが属するジャーナルID
parityGroupId	string	（任意）情報を取得する仮想LDEVが属するパリティグループ番号分散パリティグループの場合も同様に指定します。 1-3-1、1-3-2、および1-3-3の分散パリティグループの場合、次のように指定します。 parityGroupId=1-3

指定できるクエリパラメータの組み合わせの表を次に示します。

パラメータ	virtualSerialNumber	headVirtualLdevId	count	ldevOption	poolId	resourceGroupId	journalId	parityGroupId
virtualSerialNumber	－	○	○	○	○	○	○	○
headVirtualLdevId	○	－	○	○	×	×	×	×
count	○	○	－	○	○	○	○	○
ldevOption	○	○	○	－	○^※	○	×	×
poolId	○	×	○	○^※	－	○	×	×
resourceGroupId	○	×	○	○	○	－	○	○
journalId	○	×	○	×	×	○	－	×
parityGroupId	○	×	○	×	×	○	×	－

注※　ldevOptionパラメータの値にdefined、undefined、externalVolumeを指定している場合、このパラメータの組み合わせは指定できません。

詳細情報を追加して取得する場合

パラメータ	型	説明
detailInfoType	string	（任意）取得する詳細情報のタイプこのパラメータは、実行結果をフィルタリングするパラメータと組み合わせて使うこともできます。指定できる値を次に示します。複数指定する場合はコンマで区切ります。 `FMC` ドライブタイプが`SSD(FMC)`のパリティグループに属している仮想LDEVについて、容量拡張の詳細な情報を追加します。 `virtualSerialNumber` 仮想ストレージマシンの詳細な情報を追加します。 `class` ストレージシステムのキャッシュからの付加情報を追加します。ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデル、VSP F1500、Virtual Storage Platform、HUS VMの場合に指定できます。VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、SVP と連携する構成のときに指定できます。最新の情報を取得する場合、事前にストレージシステムの構成情報のキャッシュを更新するAPIを実行する必要があります。詳細については、「ストレージシステムの構成情報のキャッシュを更新する」の説明を参照してください。 LDEV 作成の直後にクエリパラメータ`ldevOption`に`defined`を同時に指定して実行した場合、ボリュームの状態が未実装のものとして出力されることがあります。この場合は、しばらく待ってから再実行するか、ストレージシステムの構成情報のキャッシュを更新するAPIを実行したあとで再度実行してください。 `qos` QoSの設定情報を追加します。ストレージシステムがVSP 5000 シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に指定できます。

パラメータ

型

説明

detailInfoType

string

（任意）取得する詳細情報のタイプ

このパラメータは、実行結果をフィルタリングするパラメータと組み合わせて使うこともできます。

指定できる値を次に示します。複数指定する場合はコンマで区切ります。

FMC
ドライブタイプがSSD(FMC)のパリティグループに属している仮想LDEVについて、容量拡張の詳細な情報を追加します。
virtualSerialNumber
仮想ストレージマシンの詳細な情報を追加します。
class

ストレージシステムのキャッシュからの付加情報を追加します。

ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデル、VSP F1500、Virtual Storage Platform、HUS VMの場合に指定できます。VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、SVP と連携する構成のときに指定できます。

最新の情報を取得する場合、事前にストレージシステムの構成情報のキャッシュを更新するAPIを実行する必要があります。詳細については、「ストレージシステムの構成情報のキャッシュを更新する」の説明を参照してください。

LDEV 作成の直後にクエリパラメータldevOptionにdefinedを同時に指定して実行した場合、ボリュームの状態が未実装のものとして出力されることがあります。この場合は、しばらく待ってから再実行するか、ストレージシステムの構成情報のキャッシュを更新するAPIを実行したあとで再度実行してください。
qos

QoSの設定情報を追加します。

ストレージシステムがVSP 5000 シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に指定できます。

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "ldevId": 0,
      "virtualLdevId": 0,
      "virtualSerialNumber": "410012",
      "clprId": 0,
      "emulationType": "OPEN-V-CVS",
      "byteFormatCapacity": "1.00 G",
      "blockCapacity": 2097152,
      "numOfPorts": 1,
      "ports": [
        {
          "portId": "CL3-B",
          "hostGroupNumber": 25,
          "hostGroupName": "bs10300-7",
          "lun": 19
        }
      ],
      "attributes": [
        "CVS",
        "HDP",
        "GAD"
      ],
      "status": "NML",
      "mpBladeId": 2,
      "ssid": "0004",
      "poolId": 4,
      "numOfUsedBlock": 0,
      "isFullAllocationEnabled": false,
      "resourceGroupId": 6,
      "dataReductionStatus": "DISABLED",
      "dataReductionMode": "disabled",
      "isAluaEnabled": false
    },
    {
      "ldevId": 1,
      "virtualLdevId": 1,
      "virtualSerialNumber": "410012",
      "clprId": 0,
      "emulationType": "OPEN-V-CVS",
      "byteFormatCapacity": "1.00 G",
      "blockCapacity": 2097152,
      "numOfPorts": 1,
      "ports": [
        {
          "portId": "CL3-B",
          "hostGroupNumber": 25,
          "hostGroupName": "bs10300-7",
          "lun": 21
        }
      ],
      "attributes": [
        "CVS",
        "HDP",
        "GAD"
      ],
      "label": "ldev_label_1",
      "status": "NML",
      "mpBladeId": 0,
      "ssid": "0004",
      "poolId": 10,
      "numOfUsedBlock": 0,
      "isFullAllocationEnabled": false,
      "resourceGroupId": 6,
      "dataReductionStatus": "DISABLED",
      "dataReductionMode": "disabled",
      "isAluaEnabled": false
    }
  ]
}

レスポンスメッセージのボディで取得する属性を次に示します。そのほかの属性については、ボリュームの情報を取得するAPIの説明を参照してください。

属性	型	説明
ldevId	int	LDEV番号
virtualLdevId	int	仮想LDEV番号
virtualSerialNumber	string	仮想ストレージマシンのシリアル番号

クエリパラメータでdetailInfoTypeにvirtualSerialNumberを指定して実行すると、仮想ストレージマシンの詳細情報も取得されます。

属性	型	説明
virtualModel	string	仮想ストレージマシンのモデル名

クエリパラメータでdetailInfoTypeにclassを指定して実行すると、ストレージシステムのキャッシュからの付加情報も取得されます。

属性	型	説明
virtualEmulationType	string	仮想LDEVの仮想エミュレーションタイプ
virtualSsId	int	仮想LDEVの仮想SSID
isVirtualCvs	boolean	仮想LDEVに仮想CVSが設定されているかどうか `true`：設定されている `false`：設定されていない

属性

型

説明

virtualEmulationType

string

仮想LDEVの仮想エミュレーションタイプ

virtualSsId

int

仮想LDEVの仮想SSID

isVirtualCvs

boolean

仮想LDEVに仮想CVSが設定されているかどうか

true：設定されている
false：設定されていない

ステータスコード

この操作のリクエストに対するステータスコードについては、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/ldevs?count=2&virtualSerialNumber=410012"

20.7 仮想LDEVの情報を取得する

20.7　仮想LDEVの情報を取得する