17.17　ライセンス情報の一覧を取得する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

メモ: ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、ライセンスを更新した直後にAPIを実行すると、ライセンスの更新が認識されずに、正常に動作しないことがあります。そのときは、しばらくしてから再度リクエストを実行してください。

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

パラメータ	型	フィルタ条件
programProductName	string	（任意）プログラムプロダクト名 `status`パラメータと同時に指定できません。
status	string	（任意）プログラムプロダクトのインストール状態指定できる値は次のとおりです。 `Installed` `Installed (Disabled)` `Not Installed` `Not Enough License` `Grace Period` `Expired` `programProductName`パラメータと同時に指定できません。

パラメータ

型

フィルタ条件

programProductName

string

（任意）プログラムプロダクト名

statusパラメータと同時に指定できません。

status

string

（任意）プログラムプロダクトのインストール状態

指定できる値は次のとおりです。

Installed
Installed (Disabled)
Not Installed
Not Enough License
Grace Period
Expired

programProductNameパラメータと同時に指定できません。

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "licenseId": 32775,
      "programProductName": "Dynamic Provisioning",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 24379
    },
    {
      "licenseId": 32835,
      "programProductName": "Dynamic Tiering",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 14682
    },
    {
      "licenseId": 32880,
      "programProductName": "Thin Image",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 940
    },
    {
      "licenseId": 32884,
      "programProductName": "global-active device",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 161
    }
  ]
}

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

{
  "data": [
    {
      "licenseId": 32775,
      "programProductName": "Dynamic Provisioning",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 24379
    }
  ]
}

取得できるライセンス情報を次に示します。ライセンス情報の詳細については、マニュアルシステム管理者ガイドまたはHitachi Device Manager - Storage Navigatorユーザガイドを参照してください。

属性	型	説明
licenseId	int	ライセンスID
programProductName	string	プログラムプロダクト名
status	string	プログラムプロダクトのインストール状態 `Installed`：インストール済み `Installed (Disabled)`：インストール済み（ライセンスが無効） `Not Installed`：インストールされていない `Not Enough License`：インストール済み（ライセンス容量不足） `Grace Period`：LDEVまたはプールボリューム追加、ペア作成によるライセンス容量不足 `Expired`：有効期限切れ `keyType`属性が`Temporary`の場合に出力されます。
keyType	string	ライセンスキーの種別 `Permanent`：購入用（無期限） `Term`：購入用（有効期間あり） `Temporary`：購入前のお試し用 `Emergency`：非常用
capacityLimitStatus	string	ライセンスの許可容量に制限があるかどうか `Limited`：制限あり `Unlimited`：制限なし
permittedCapacityInTB	long	ライセンスの許可容量（TB）
usedCapacityInGB	long	プログラムプロダクトが使用しているボリューム容量（GB）
remainingDays	int	ライセンスの残日数 `keyType`属性が`Term`、`Temporary`または`Emergency`の場合：有効期限までの残日数 `keyType`属性が`Temporary`のライセンスが失効している場合：失効したあと再びインストールが可能になるまでの残日数

ステータスコード

この操作のリクエストに対するステータスコードについては、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/800000012345/licenses

17.17 ライセンス情報の一覧を取得する

17.17　ライセンス情報の一覧を取得する