Getting namespace 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 namespace information.
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/namespaces

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

nvmSubsystemId

int

(Required) NVM subsystem ID

Body
None.

Response message

Body
{
    "data":[
             {
               "namespaceObjectId":"1,1",
               "namespaceId":1,
               "namespaceNickname":"restns11",
               "nvmSubsystemId":1,
               "nvmSubsystemName":"rest_subsystem",
               "ldevId":2000,
               "byteFormatCapacity":"1.00 G",
               "blockCapacity":2097152
             },
             {
               "namespaceObjectId":"1,2",
               "namespaceId":2,
               "namespaceNickname":"restns12",
               "nvmSubsystemId":1,
               "nvmSubsystemName":"rest_subsystem",
               "ldevId":2001,
               "byteFormatCapacity":"1.00 G",
               "blockCapacity":2097152
             }
     ]
}

Attribute

Type

Description

namespaceObjectId

string

Object ID of the namespace

The following attributes are output, separated by commas:

  • nvmSubsystemId
  • namespaceId

namespaceId

int

Namespace ID

namespaceNickname

string

Namespace nickname

If the namespace nickname is not set, a hyphen (-) is output.

nvmSubsystemId

int

NVM subsystem ID

nvmSubsystemName

string

NVM subsystem name

ldevId

int

LDEV number

LDEV number of the volume where the namespace is set

byteFormatCapacity

string

Capacity of the namespace

blockCapacity

long

Number of blocks of the namespace

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/namespaces?nvmSubsystemId=1