5.1 すべてのホストの情報を取得する

APIを実行するユーザーの権限で参照できるすべてのホストの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://<host>:<port>/ComputeSystemsManager/v1/objects/Hosts

リクエストボディー

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

レスポンスボディー

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

Host

{
   "Host":[{
       "instanceId":"...",
       "hostName":"...",
       "osName":"...",
       "manufacturer":"...",
       "ipAddress":"...",
       "productName":"...",
       "hostStatus":"...",
       "serialNumber":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...
   },
   :
   ]
}

属性データ型説明
instanceIdstring1URIでホストを特定する際に使用する識別子。IPアドレスをbase64urlでエンコードした文字列。
hostNamestring1ホスト名。
osNamestring1OS名。
manufacturerstring1ベンダー名。
ipAddressstring1ホストのIPアドレス。
productNamestring1プロダクト名称。ホストの搭載されているサーバの名称。
hostStatusstring1ホストの稼働状態。
  • Running
  • Stopped
  • Unknown
serialNumberstring1シリアル番号。
lastRefresheddateTime1最終更新日時。
errorinteger1解決していない障害レベルのアラート数。
warninginteger1解決していない警告レベルのアラート数。
informationinteger1解決していない情報レベルのアラート数。

リターンコード

HTTPステータスコード結果コード詳細コード説明
200--正常終了。
40110001HTTPヘッダーのAuthorizationが指定されていません。
40110002HTTPヘッダーのAuthorizationの値が不正です(Basic認証,HSSOセッション認証のどちらでもありません)。
40110003HTTPヘッダーのAuthorizationのBasic認証の値が不正です(認証情報のフォーマットが不正です)。
40110004ログインに失敗しました。
40110021ログインセッションが切断されました。または,不正なHSSOトークンが指定されました。
40310031基本ライセンスが登録されていない,または有効期限を過ぎています。
40320171管理対象を参照または操作する権限がありません。
405--サポートされていないメソッドです。
40620101HTTPヘッダーのAcceptの値が不正です。
415--HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500--HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。
50010001ログインに失敗しました(内部エラー)。
5003000100内部エラーが発生しました。
50320201要求の数がAPIの同時最大接続数を超えました。