instanceIDに指定したLPARの情報を取得します。
ロール
Admin/Modify/View
リクエストライン
GET http://<host>:<port>/ComputeSystemsManager/v1/objects/Lpars/<instanceID>
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。
Lpar
{
"Lpar":[{
"instanceId":"...",
"serverUniqueKey":"...",
"lparNo":...,
"lparName":"...",
"lparManagerId":"...",
"lparStatus":"...",
"migrationStatus":"...",
"lastRefreshed":"...",
"error":...,
"warning":...,
"information":...,
"activationOrder":"...",
"autoClearSystemEventLog":"...",
"virtualConsole":"...",
"cpuAllocation":"...",
"numberOfLogicalCpus":...,
"cpuGroup":...,
"cpuAllocationRatio":...,
"cpuIdleDetection":"...",
"cpuPerformanceCapping":"...",
"memorySizeInMB":...,
"memoryNode":"...",
"guestNUMA":"...",
"preBootFirmware":"...",
"guestOs":"...",
"guestIdleMode":"...",
"lowLatency":"..."
}]
}
属性 | データ型 | 数 | 説明 |
---|---|---|---|
instanceId | string | 1 | URIでLPARを特定する際に使用する識別子。serverUniqueKey+"_"+LPAR番号をbase64urlでエンコードした文字列。 |
serverUniqueKey | string | 1 | LPARが搭載されているブレードサーバを特定する識別子。 |
lparNo | integer | 1 | LPAR番号。 |
lparName | string | 1 | LPAR名。 |
lparManagerId | string | 1 | HVM ID。 |
lparStatus | string | 1 | LPARの稼働状態。
|
migrationStatus | string | 1 | マイグレーションの実行状態。
|
lastRefreshed | dateTime | 1 | 最終更新日時。 |
error | integer | 1 | 解決していない障害レベルのアラート数。 |
warning | integer | 1 | 解決していない警告レベルのアラート数。 |
information | integer | 1 | 解決していない情報レベルのアラート数。 |
activationOrder | string | 1 | LPARが自動起動する際の起動順序(1~99)。HVM起動時に,数値の昇順にLPARを自動起動します。
|
autoClearSystemEventLog | string | 1 | システムイベントログの自動削除の設定。
|
virtualConsole | string | 1 | 仮想COMコンソール機能の有効/無効の設定。仮想COMコンソール機能が有効な場合は,仮想COM番号(整数)。無効な場合は'*'。 |
cpuAllocation | string | 1 | CPUの割り当てモード。
|
numberOfLogicalCpus | integer | 1 | 論理プロセッサの数。 |
cpuGroup | integer | 1 | プロセッサグループ。 |
cpuAllocationRatio | integer | 1 | プロセッサのサービス率(1~999)。cpuAllocationの値がShareの場合に有効な情報です。 |
cpuIdleDetection | string | 1 | アイドル検出機能の設定。
|
cpuPerformanceCapping | string | 1 | プロセッサキャッピング機能の設定。
|
memorySizeInMB | integer | 1 | メモリーサイズ(MB)。 |
memoryNode | string | 1 | メモリーノード。
|
guestNUMA | string | 0~1 | ゲストNUMA機能の設定。
|
preBootFirmware | string | 1 | Pre-bootファームウェアの種別。
|
guestOs | string | 1 | OS種別。
|
guestIdleMode | string | 0~1 | ゲストアイドルモードの種別。アイドル検出機能の設定がEnableの場合,またはゲストアイドルモードがサポートされていない場合,空文字列です。
|
lowLatency | string | 0~1 | Low Latency機能の設定。HVMがLow Latency機能をサポートしていない場合,空文字列です。
|
リターンコード
HTTPステータスコード | 結果コード | 詳細コード | 説明 |
---|---|---|---|
200 | - | - | 正常終了。 |
204 | - | - | 指定したinstanceIDまたはcollectionはありません。 |
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。 |
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です(Basic認証,HSSOセッション認証のどちらでもありません)。 |
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です(認証情報のフォーマットが不正です)。 |
401 | 1000 | 4 | ログインに失敗しました。 |
401 | 1002 | 1 | ログインセッションが切断されました。または,不正なHSSOトークンが指定されました。 |
403 | 1003 | 1 | 基本ライセンスが登録されていない,または有効期限を過ぎています。 |
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。 |
403 | 2017 | 1 | 管理対象を参照する権限がありません。 |
405 | - | - | サポートされていないメソッドです。 |
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。 |
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。 |
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。 |
500 | 1000 | 1 | ログインに失敗しました(内部エラー)。 |
500 | 3000 | 100 | 内部エラーが発生しました。 |
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。 |