Getting Host-namespace path information

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets Host-namespace path information (information related to the namespace and host NQN) by specifying the NVM subsystem.

Depending on the number of resources for which you are getting information, one API request might not be able to get all the information. To get the remaining information, see the explanations of the hasNext attribute and the NextId attribute.

Note:

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/namespace-paths

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

nvmSubsystemId

int

(Required) NVM subsystem ID

Specify a value from 0 to 2047.

namespaceId

int

(Optional) Namespace ID

For the VSP 5000 series, specify a value from 1 to 4096. For VSP E1090 and VSP E1090H, specify a value from 1 to 2048.

You cannot specify this parameter at the same time as the headId parameter.

headId

string

(Optional) Namespace object ID

Specify the object ID of the Host-namespace path where the getting of the information starts.

You cannot specify this parameter at the same time as the namespaceId parameter.

If both this parameter and namespaceId parameter are omitted, the request gets information from the beginning of the information.

Body
None.

Response message

Body
{
    "data": [
        {
            "namespacePathId":"1,nqn.2014-08.org.example:uuid:
ff533865-1d0b-4043-8345-a90afbb80d8b,2",
            "nvmSubsystemId":1,
            "hostNqn":"nqn.2014-08.org.example:uuid:
ff533865-1d0b-4043-8345-a90afbb80d8b",
            "namespaceId":2,
            "ldevId":10
        },
        {
            "namespacePathId":"1,nqn.2014-08.org.example:uuid:
ff533865-1d0b-4043-8345-a90afbb80d8b,3",
            "nvmSubsystemId":1,
            "hostNqn":"nqn.2014-08.org.example:uuid:
ff533865-1d0b-4043-8345-a90afbb80d8b",
            "namespaceId":3,
            "ldevId":11
        },
        ...
    ],
    "hasNext":true
    "nextId":"1,nqn.2014-08.org.example:uuid:
ff533865-1d0b-4043-8345-a90afbb80d8b,42"
}

Attribute

Type

Description

namespacePathId

string

Object ID of the Host-namespace path

The following attributes are output, separated by commas:

  • nvmSubsystemId
  • hostNqn
  • namespaceId

nvmSubsystemId

int

NVM subsystem ID

hostNqn

string

Host NQN

namespaceId

int

Namespace ID

ldevId

int

LDEV number

LDEV number of the volume where the namespace is set

This API request outputs the following attributes, in accordance with the data object.

Attribute

Type

Description

hasNext

boolean

Whether or not there is information that this API request could not get.

  • true: There is information that this API request could not get.
  • false: The request could get all the information.

For the VSP 5000 series, false is always output.

nextId

string

ID for getting continued information if there is information this API request could not get yet.

If the API request could not get all the information at one time, by specifying this value in the query parameter headId and rerunning the API request, you can get the next information.

This information is not output if the hasNext attribute is false.

Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/namespace-paths?nvmSubsystemId=1