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":...
},
:
]
}
属性 | データ型 | 数 | 説明 |
---|---|---|---|
instanceId | string | 1 | URIでホストを特定する際に使用する識別子。IPアドレスをbase64urlでエンコードした文字列。 |
hostName | string | 1 | ホスト名。 |
osName | string | 1 | OS名。 |
manufacturer | string | 1 | ベンダー名。 |
ipAddress | string | 1 | ホストのIPアドレス。 |
productName | string | 1 | プロダクト名称。ホストの搭載されているサーバの名称。 |
hostStatus | string | 1 | ホストの稼働状態。
|
serialNumber | string | 1 | シリアル番号。 |
lastRefreshed | dateTime | 1 | 最終更新日時。 |
error | integer | 1 | 解決していない障害レベルのアラート数。 |
warning | integer | 1 | 解決していない警告レベルのアラート数。 |
information | integer | 1 | 解決していない情報レベルのアラート数。 |
リターンコード
HTTPステータスコード | 結果コード | 詳細コード | 説明 |
---|---|---|---|
200 | - | - | 正常終了。 |
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の同時最大接続数を超えました。 |