CA Portにログイン中のHost情報の取得

GET /host/connected

概要説明

CA Portにログイン中のHost情報を取得します。

CA Portにログイン中のHost情報の応答順は以下です。

  • FC Portにログイン中のHost情報をすべて応答したあとに、iSCSI Portにログイン中のHost情報を応答します。

  • FC Portにログイン中のHost情報は、WWNの昇順で応答します。

  • iSCSI Portにログイン中のHost情報は、IP Addressの昇順で応答します。

注意

  • CA Portにログイン中のFC Host、iSCSI Hostの情報のみ応答します。

  • テナントユーザーの場合、自テナントに属するHostおよび未登録のHostのログイン中のCA Port情報を応答します。

    未登録HostをCA Portに接続したままにしておくと、他テナントにIP Address、WWNなどの情報が流出してしまう可能性があるため、CA Portに接続後は速やかに該当Hostを登録してください。

リクエスト例

  • CA Portにログイン中のFC Hostについて、情報を取得する場合の例です。

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

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "connected_host_list": [
    {
      "type": "FC",
      "host_id": 256,
      "host_href": "/api/v1/host/256",
      "host_name": "HBA#1",
      "connected_caport_href_list": [
        "/api/v1/caport/0000",
        "/api/v1/caport/0100"
      ],
      "wwn": "40000000abc80e38",
      "ip_address": "192.168.1.10",
      "iscsi_name": "iqn.1991-05.com.microsoft"
    }
  ],
  "next_href": "/api/v1/volume?is_used_status_attention=true&fields=number,name&last_get_id=100005"
}

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個まで指定可能です。
is_unregistered_host

boolean

装置に未登録Host情報のみを応答するかどうか。

trueを指定した場合、装置に未登録Host情報のみを応答します。
max_records

integer

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

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

入力条件：

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

string

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

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

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

入力条件：

  • FC Hostの場合、fc_"WWN"を指定してください。

  • iSCSI Hostの場合、iscsi_"IP Address"を指定してください。

    • 例えば、fc_40000000abc80e38またはiscsi_192.168.1.161 は指定可能です。

Responses

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

RESPONSE BODY

total_count

integer

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

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

integer

応答するListの個数。
connected_host_list

Array of objects

type

string

Hostタイプ。
項目 説明
FC FC Host
iSCSI iSCSI Host
host_id

integer

Host ID。

装置に登録済みHostの場合に限り応答します。
host_href

string

Host ResourceへのLink。

装置に登録済みHostの場合に限り応答します。
host_name

string

Host Name。

装置に登録済みHostの場合に限り応答します。
connected_caport_href_list

Array of strings

Hostがログイン中のCA Port ResourceへのLink。
wwn

string

FC HostのWWN。

FC以外の場合は応答しません。
ip_address

string

iSCSI HostのIPアドレス。

iSCSI以外の場合は応答しません。
iscsi_name

string

iSCSI HostのiSCSI Name。

iSCSI以外の場合は応答しません。
next_href

string

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

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

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