Obtaining Connection Information About the Specified Host

Introduction

Obtains the Connection for the Host specified by host_id.

Responds the Connection information by volume_id in ascending order.

Request Examples

This is an example of getting Connection information about FC Host with Host ID 2.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/connection/host/2"

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "connection_list": [
    {
      "connection_href": "/api/v1/connection/host/1/volume/100001",
      "host_href": "/api/v1/host/1",
      "hostresponse_name": "Default",
      "volume_href": "/api/v1/volume/100001",
      "hlun": 0,
      "lungroup_number": 0,
      "is_unexpected_connection": false,
      "caport_href_list": [
        "/api/v1/caport/0000",
        "/api/v1/caport/0100"
      ],
      "shared_host_href_list": [
        "/api/v1/host/2",
        "/api/v1/host/3"
      ]
    }
  ]
}

Parameters

PATH PARAMETERS

host_id

(required)

integer

Host ID.

QUERY PARAMETERS

fields	Array of strings Parameter to display. Only the information of the specified Parameter name (Response Body Parameter) is extracted and retrieved. For details about the specification methods, see Property Filter.
volume_id	Array of integers Volume ID. Specify the Volume ID for which you want information. Input criteria: You can specify up to 256 values.
hlun	Array of integers The number of the Volume as seen by the Host. Specify the hlun for which you want information. Input criteria: You can specify up to 256 values.
max_records	integer The maximum number of resources for which you want information. Specify this parameter when you want to limit the number of pieces of information that can be answered. Input criteria The range of allowed values is 1 to 512.
last_get_id	integer The identifier of the resource for which to retrieve further information. If all resources matching the response conditions cannot be answered at once, next_href is returned. The last_get_id is the information given to next_href to retrieve further information.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

total_count

integer

The total number of Resources present in the device.

If a filter is applied, this is the total number of Resources that meet the criteria.

list_count

integer

Number of Lists to respond.

connection_list

Array of objects

connection_href	string Link to Host Resource. It always responds.
host_href	string Link to Host Resource.
host_name	string Host Name.
hostresponse_name	string Host Response Name.
volume_href	string Link to Host Resource.
volume_name	string Name of the Volume connected to the specified Host.
hlun	integer The number of the Volume as seen by the Host.
lungroup_number	integer Lun Group Number.
is_unexpected_connection	boolean True if the Host in this Connection is connected to more than one LUN Group. If true, the same Volume may have different Host Affinity settings for each CA Port. Therefore, the same Volume may be referenced by different hlun through the CA Ports listed in the returned caport_href_list.
caport_href_list	Array of strings Link to the CA Port Resource.
shared_host_href_list	Array of strings Link to the Host that shares the LUN Group to which the Volume belongs.
shared_host_name_list	Array of strings Name of the Host that shares the LUN Group to which the Volume belongs. This item is not returned if the LUN Group is not shared by any host or if a tenant user executed this command.

next_href

string

Link to get more information.

This item is returned only when it is not possible to respond all information at once.

For example, this item is responded if there are more Resources that match the response condition than the number specified by max_records.