Getting information about the connections between volumes and servers

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request gets information about the connections between volumes and servers by using the server IDs or server nicknames of the specified servers.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/volume-server-connections

Request message

Object ID
None.
Query parameters

With each request, you can obtain information about a maximum of 2,048 connections between volumes and the server. To obtain information about additional connections between volumes and the server, run the API request multiple times by using a combination of the count and startVolumeId parameters. By specifying the count parameter, you can also filter the volume information you require.

Parameter

Type

Filter Condition

serverId int

(Optional) Specify the server ID of the server connected to the volume.

The connection information of the server with the specified ID will be obtained.

Specify either serverId or serverNickname. Do not specify both of these parameters together.

serverNickname

string

(Optional) Specify the server nickname of the server connected to the volume.

The connection information of the server with the specified server nickname will be obtained.

Specify either serverId or serverNickname. Do not specify both of these parameters together.

startVolumeId

int

(Optional) Specify a value in the range from 0 through 65279 as the volume ID from which to start obtaining information about the connections between volumes and the server.

count

int

(Optional) Specify a value in the range from 1 through 2048 as the number of connections for which to obtain information about connections between volumes and the server.

If this parameter is omitted, 2048 is assumed.

Body
None.

Response message

Body

The following is an example of getting information about volumes and connection of the server with ID 10 (specifying 10 for the serverId query parameter).

{
  "data": [
    {
      "id": "100,10",
      "volumeId": 100,
      "serverId": 10,
      "luns": [
        {
          "lun": 1,
          "portId": "CL1-A"
        }
      ]
    },
    {
      "id": "101,10",
      "volumeId": 101,
      "serverId": 10,
      "luns": [
        {
          "lun": 2,
          "portId": "CL1-A"
        }
      ]
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute

Type

Description

id

string

The volume ID and the server ID appear in a format in which they are connected by a comma.

volumeId

int

Volume ID

serverId

int

Server ID

luns

object[]

Information about the LUN appears:

  • lun (int)

    LU number

  • portId (string)

    ID of the port to which the LU number is assigned

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/volume-server-connections?serverId=10