Compute Systems Manager REST API リファレンスガイド

[目次][前へ][次へ]

3.6 スイッチモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのスイッチモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Switchmodule

instanceID:
chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

SwitchModule 

{
    "SwitchModule":[{
        "chassisUniqueKey":"...",
        "switchUniqueKey":"...",
        "serialNumber":"...",
        "slotNo":...,
        "installStatus":"...",
        "powerStatus":"...",
        "healthStatus":"...",
        "maintenanceMode":"...",
        "switchType":"...",
        "modelNumber":"...",
        "lidStatus":"...",
        "lidColor":"...",
        "firmwareVersion":"...",
        "ipAddress":"...",
        "subnetMask":"...",
        "defaultGateway":"..."
    },
    :
    ]
}
属性 データ型 数 説明
chassisUniqueKey string 1 スイッチモジュールが搭載されているシャーシを特定する識別子。
switchUniqueKey string 1 スイッチユニークキー。スイッチモジュールを特定する識別子。
serialNumber string 1 シリアル番号。
slotNo integer 1 スロット番号。
installStatus string 1 搭載状態。
  • INSTALL
  • NOT_INSTALL
  • NA
powerStatus string 1 電源状態。
  • OFF
  • ON
  • UNKNOWN
healthStatus string 1 スイッチモジュールの稼働状態。
  • NORMAL：正常
  • WARNING：警告
  • FAIL：障害
  • UNKNOWN：不明
maintenanceMode string 1 スイッチモジュールの保守モードの設定。
  • TRUE：保守モードに設定されています。
  • FALSE：保守モードに設定されていません。
switchType string 1 スイッチモジュールの種類。
例：
'1Gb LAN SW'
'1/10Gb LAN SW'
'8Gb FC SW'
'10Gb DCB Switch Module'
'LAN pass through'
'1Gb 40 ports LAN SW'
'JIG SW'
'Unknown'
modelNumber string 1 モデル番号。
lidStatus string 1 LID状態。
  • ON
  • OFF
  • BLINKING
  • SLOW_BLINKING
  • FAST_BLINKING
  • UNKNOWN
lidColor string 1 LIDの表示色。
  • BLUE
  • GREEN
  • RED
  • ORANGE
  • UNKNOWN
firmwareVersion string 1 ファームウェアバージョン。
ipAddress string 1 IPアドレス。値が設定されていない場合，空文字列です。
subnetMask string 1 サブネットマスク。値が設定されていない場合，空文字列です。
defaultGateway string 1 デフォルトゲートウェイIPアドレス。値が設定されていない場合，空文字列です。

リターンコード

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 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の同時最大接続数を超えました。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.