Retrieve NVMe namespaces
GET /storage/namespaces
Introduced In: 9.6
Retrieves NVMe namespaces.
Expensive properties
There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields
query parameter. See Requesting specific fields to learn more.
-
auto_delete
-
subsystem_map.*
-
status.mapped
-
statistics.*
-
metric.*
Related ONTAP commands
-
vserver nvme namespace show
-
vserver nvme subsystem map show
Learn more
-
DOC /storage/namespaces to learn more and examples.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string |
query |
False |
Filter by name |
auto_delete |
boolean |
query |
False |
Filter by auto_delete |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
space.used |
integer |
query |
False |
Filter by space.used |
space.size |
integer |
query |
False |
Filter by space.size
|
space.block_size |
integer |
query |
False |
Filter by space.block_size |
space.guarantee.requested |
boolean |
query |
False |
Filter by space.guarantee.requested |
space.guarantee.reserved |
boolean |
query |
False |
Filter by space.guarantee.reserved |
os_type |
string |
query |
False |
Filter by os_type |
metric.status |
string |
query |
False |
Filter by metric.status
|
metric.throughput.total |
integer |
query |
False |
Filter by metric.throughput.total
|
metric.throughput.write |
integer |
query |
False |
Filter by metric.throughput.write
|
metric.throughput.read |
integer |
query |
False |
Filter by metric.throughput.read
|
metric.duration |
string |
query |
False |
Filter by metric.duration
|
metric.latency.write |
integer |
query |
False |
Filter by metric.latency.write
|
metric.latency.read |
integer |
query |
False |
Filter by metric.latency.read
|
metric.latency.other |
integer |
query |
False |
Filter by metric.latency.other
|
metric.latency.total |
integer |
query |
False |
Filter by metric.latency.total
|
metric.timestamp |
string |
query |
False |
Filter by metric.timestamp
|
metric.iops.write |
integer |
query |
False |
Filter by metric.iops.write
|
metric.iops.read |
integer |
query |
False |
Filter by metric.iops.read
|
metric.iops.other |
integer |
query |
False |
Filter by metric.iops.other
|
metric.iops.total |
integer |
query |
False |
Filter by metric.iops.total
|
create_time |
string |
query |
False |
Filter by create_time
|
location.namespace |
string |
query |
False |
Filter by location.namespace |
location.volume.uuid |
string |
query |
False |
Filter by location.volume.uuid |
location.volume.name |
string |
query |
False |
Filter by location.volume.name |
location.node.uuid |
string |
query |
False |
Filter by location.node.uuid
|
location.node.name |
string |
query |
False |
Filter by location.node.name
|
location.qtree.id |
integer |
query |
False |
Filter by location.qtree.id
|
location.qtree.name |
string |
query |
False |
Filter by location.qtree.name |
enabled |
boolean |
query |
False |
Filter by enabled |
statistics.iops_raw.write |
integer |
query |
False |
Filter by statistics.iops_raw.write
|
statistics.iops_raw.read |
integer |
query |
False |
Filter by statistics.iops_raw.read
|
statistics.iops_raw.other |
integer |
query |
False |
Filter by statistics.iops_raw.other
|
statistics.iops_raw.total |
integer |
query |
False |
Filter by statistics.iops_raw.total
|
statistics.status |
string |
query |
False |
Filter by statistics.status
|
statistics.latency_raw.write |
integer |
query |
False |
Filter by statistics.latency_raw.write
|
statistics.latency_raw.read |
integer |
query |
False |
Filter by statistics.latency_raw.read
|
statistics.latency_raw.other |
integer |
query |
False |
Filter by statistics.latency_raw.other
|
statistics.latency_raw.total |
integer |
query |
False |
Filter by statistics.latency_raw.total
|
statistics.throughput_raw.total |
integer |
query |
False |
Filter by statistics.throughput_raw.total
|
statistics.throughput_raw.write |
integer |
query |
False |
Filter by statistics.throughput_raw.write
|
statistics.throughput_raw.read |
integer |
query |
False |
Filter by statistics.throughput_raw.read
|
statistics.timestamp |
string |
query |
False |
Filter by statistics.timestamp
|
subsystem_map.nsid |
string |
query |
False |
Filter by subsystem_map.nsid |
subsystem_map.anagrpid |
string |
query |
False |
Filter by subsystem_map.anagrpid |
subsystem_map.subsystem.uuid |
string |
query |
False |
Filter by subsystem_map.subsystem.uuid |
subsystem_map.subsystem.name |
string |
query |
False |
Filter by subsystem_map.subsystem.name
|
comment |
string |
query |
False |
Filter by comment
|
uuid |
string |
query |
False |
Filter by uuid |
status.mapped |
boolean |
query |
False |
Filter by status.mapped |
status.container_state |
string |
query |
False |
Filter by status.container_state |
status.state |
string |
query |
False |
Filter by status.state |
status.read_only |
boolean |
query |
False |
Filter by status.read_only |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
The number of records in the response. |
records |
array[nvme_namespace] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"clone": {
"source": {
"name": "/vol/volume1/namespace1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"comment": "string",
"consistency_group": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cg1",
"uuid": "4abc2317-4332-9d37-93a0-20bd29c22df0"
},
"convert": {
"lun": {
"name": "/vol/volume1/lun1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"create_time": "2018-06-04 15:00:00 -0400",
"encryption": {
"action": "string",
"key_create_time": "2022-01-01 14:00:00 -0500",
"key_id": "string",
"key_manager_attribute": "CRN=v1:bluemix:public:containers-kubernetes:us-south:a/asdfghjkl1234:asdfghjkl1234:worker:kubernetes-asdfghjkl-worker1",
"state": "string",
"status": {
"code": "string",
"message": "string"
},
"type": "string"
},
"location": {
"namespace": "namespace1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"qtree": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"id": 1,
"name": "qt1"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"name": "/vol/volume1/qtree1/namespace1",
"os_type": "string",
"qos_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "qos1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"space": {
"block_size": 512,
"size": 1073741824,
"used": 0
},
"statistics": {
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"status": {
"container_state": "string",
"state": "online"
},
"subsystem_map": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"anagrpid": "00103050h",
"nsid": "00000001h",
"subsystem": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "subsystem1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
source
The source NVMe namespace for a namespace clone operation. This can be specified using property clone.source.uuid
or clone.source.name
. If both properties are supplied, they must refer to the same namespace.
Valid in POST to create a new NVMe namespace as a clone of the source.
Valid in PATCH to overwrite an existing NVMe namespace's data as a clone of another.
Name | Type | Description |
---|---|---|
name |
string |
The fully qualified path name of the clone source NVMe namespace composed of a "/vol" prefix, the volume name, the (optional) qtree name and base name of the namespace. Valid in POST and PATCH. |
uuid |
string |
The unique identifier of the clone source NVMe namespace. Valid in POST and PATCH. |
clone
This sub-object is used in POST to create a new NVMe namespace as a clone of an existing namespace, or PATCH to overwrite an existing namespace as a clone of another. Setting a property in this sub-object indicates that a namespace clone is desired.
When used in a PATCH, the patched NVMe namespace's data is over-written as a clone of the source and the following properties are preserved from the patched namespace unless otherwise specified as part of the PATCH: auto_delete
(unless specified in the request), subsystem_map
, status.state
, and uuid
.
Name | Type | Description |
---|---|---|
source |
The source NVMe namespace for a namespace clone operation. This can be specified using property Valid in POST to create a new NVMe namespace as a clone of the source. Valid in PATCH to overwrite an existing NVMe namespace's data as a clone of another. |
consistency_group
The NVMe namespace's consistency group. This property is populated for NVMe namespaces that are members of a consistency group. If the NVMe namespace is a member of a child consistency group, the parent consistency group is reported.
=== Platform Specifics
-
Unified ONTAP: An NVMe namespace's consistency group is the consistency group