全Host情報の取得

GET /host

概要説明

Hostの情報を取得します。

Host IDの昇順で情報を格納します。

注意

FC Host、iSCSI Hostの情報のみ応答します。

リクエスト例

  • FC Hostについて、情報を取得する場合の例です。

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/host?type=FC"

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "host_list": [
    {
      "host_id": 256,
      "host_href": "/api/v1/host/256",
      "type": "FC",
      "number": 256,
      "name": "HBA#1",
      "wwn": "40000000abc80e38",
      "host_response_name": "Default",
      "is_shared_host_exist": false
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。
host_id

Array of integers

Host ID。

情報を取得したいHostのIDを指定します。

入力条件：

  • 256個まで指定可能です。
type

Array of strings

Hostタイプ。

情報を取得したいHostのタイプを指定します。
項目 説明
FC FC Host
iSCSI iSCSI Host

入力条件：

  • 2個まで指定可能です。
status

Array of strings

ステータス。

情報を取得したいHostのステータスを指定します。
項目 説明
Unused 未使用のHostです。
Normal 接続中のVolumeがすべてNormalです。
Maintenance 接続中のVolumeにMaintenanceのものが存在、かつErrorまたはWarningのVolumeが存在しません。
Warning 接続中のVolumeにWarningのものが存在、かつErrorのVolumeが存在しません。
Error 接続中のVolumeにErrorのVolumeが存在します。

入力条件：

  • 5個まで指定可能です。
max_records

integer

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

  • 指定可能な範囲は1～512です。
start_number

integer

Default: 0

情報を取得したいリソースの先頭のNumber。
last_get_id

integer

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

total_count

integer

装置に存在するResourceの総数。

フィルタリングしている場合は、条件に合致するResourceの総数です。
list_count

integer

応答するListの個数。
host_list

Array of objects

GET /host/host_idで取得できる情報を、list_count数分出力します。詳細は、Host情報の取得の「Responses」を参照してください。
next_href

string

続きの情報を取得するためのLink。

一度にすべての情報を応答しきることができなかった場合に限り応答します。

例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。