1.2.5 ライセンス

機能

ライセンス一覧表示

処理概要

システムに登録されているライセンスを一覧表示します。

ライセンスの合計容量が60TB以上である場合、“total_license_capacity”には登録済みライセンスのうち、本製品として有効な容量の上限である60TBを出力します。

“total_license_capacity_real”には無効な容量が含まれた合計容量を出力します。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
filter_cols	フィルターするカラム名を指定します。 “,”で連結して複数のカラムを指定することが可能です。 [例] id,license_type	任意	string	query
filter_vals	filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。数値の場合、“~”で範囲を指定することが可能です。 [例] 1~*,REGULAR	任意	string	query
sort_cols	ソートするカラム名を指定します。 [例] id,license_type	任意	string	query
sort_vals	sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。昇順: asc 降順: desc [例] asc,asc,desc	任意	string	query
show_cols	表示するカラム名を指定します。 [例] id,license_type	任意	string	query
hide_cols	非表示にするカラム名を指定します。 [例] id,license_type	任意	string	query
limit	表示する項目数を指定します。	任意	integer	query
offset	項目の表示開始位置を指定します。	任意	integer	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	表示	形式
200	total_license_capacity	登録済みライセンスのうち本製品として有効な総容量(TB)	Yes	integer
	total_license_capacity_real	登録済みライセンスの実際の総容量(TB)	Yes	integer
	licenses	ライセンスの個々の情報	Yes	オブジェクトの配列

licenseのオブジェクト配列は以下のとおりです。

データを格納するキー名: license

キー	説明	表示	形式	列挙型定数
id	登録ライセンスのID	Yes	integer
license_type	ライセンス種別正規ライセンストライアルライセンス	Yes	enum	REGULAR: 正規ライセンス TRIAL: トライアルライセンス
name	ライセンス名称	Yes	string
capacity	ライセンス容量(TB)	Yes	integer
registration_date	ライセンス登録日 (YYYY-MM-DDThh:mm:ss+hh:mm)	Yes	timestamp
expiration_date	ライセンス有効期限 (トライアルの場合だけ) (YYYY-MM-DDThh:mm:ss+hh:mm)	Yes	timestamp
license_validity	ライセンスの有効性 true : 有効 false : 無効	Yes	boolean

機能

ライセンス登録