Retrieve a collection of plexes for an aggregate
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /storage/aggregates/{aggregate.uuid}/plexes
Introduced In: 9.6
Retrieves the collection of plexes for the specified aggregate.
Related ONTAP commands
-
storage aggregate plex show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
aggregate.uuid |
string |
path |
True |
Aggregate UUID |
aggregate.name |
string |
query |
False |
Filter by aggregate.name |
pool |
string |
query |
False |
Filter by pool |
state |
string |
query |
False |
Filter by state |
resync.active |
boolean |
query |
False |
Filter by resync.active |
resync.percent |
integer |
query |
False |
Filter by resync.percent |
resync.level |
string |
query |
False |
Filter by resync.level |
raid_groups.reconstruct.active |
boolean |
query |
False |
Filter by raid_groups.reconstruct.active
|
raid_groups.reconstruct.percent |
integer |
query |
False |
Filter by raid_groups.reconstruct.percent
|
raid_groups.degraded |
boolean |
query |
False |
Filter by raid_groups.degraded
|
raid_groups.disks.disk.name |
string |
query |
False |
Filter by raid_groups.disks.disk.name
|
raid_groups.disks.state |
string |
query |
False |
Filter by raid_groups.disks.state
|
raid_groups.disks.usable_size |
integer |
query |
False |
Filter by raid_groups.disks.usable_size
|
raid_groups.disks.type |
string |
query |
False |
Filter by raid_groups.disks.type
|
raid_groups.disks.position |
string |
query |
False |
Filter by raid_groups.disks.position
|
raid_groups.cache_tier |
boolean |
query |
False |
Filter by raid_groups.cache_tier
|
raid_groups.recomputing_parity.percent |
integer |
query |
False |
Filter by raid_groups.recomputing_parity.percent
|
raid_groups.recomputing_parity.active |
boolean |
query |
False |
Filter by raid_groups.recomputing_parity.active
|
raid_groups.raid_type |
string |
query |
False |
Filter by raid_groups.raid_type
|
raid_groups.name |
string |
query |
False |
Filter by raid_groups.name
|
online |
boolean |
query |
False |
Filter by online |
name |
string |
query |
False |
Filter by name |
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 |
||
error |
||
num_records |
integer |
Number of records |
records |
array[plex] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
},
"num_records": 1,
"records": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"name": "plex0",
"pool": "string",
"raid_groups": [
{
"disks": [
{
"disk": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "1.0.1"
},
"position": "string",
"state": "string",
"type": "ssd",
"usable_size": 947912704
}
],
"name": "rg0",
"raid_type": "raid_dp",
"recomputing_parity": {
"percent": 10
},
"reconstruct": {
"percent": 10
}
}
],
"resync": {
"level": "string",
"percent": 10
},
"state": "string"
}
]
}
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 |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
_links
Name | Type | Description |
---|---|---|
self |
aggregate
Aggregate
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
disk
Disk
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
raid_group_disk
Name | Type | Description |
---|---|---|
disk |
Disk |
|
position |
string |
The position of the disk within the RAID group. |
state |
string |
The state of the disk within the RAID group. |
type |
string |
Disk interface type |
usable_size |
integer |
Size in bytes that is usable by the aggregate. |
recomputing_parity
Name | Type | Description |
---|---|---|
active |
boolean |
RAID group is recomputing parity |
percent |
integer |
Recomputing parity percentage |
reconstruct
Name | Type | Description |
---|---|---|
active |
boolean |
One or more disks in this RAID group are being reconstructed. |
percent |
integer |
Reconstruct percentage |
raid_group
Name | Type | Description |
---|---|---|
cache_tier |
boolean |
RAID group is a cache tier |
degraded |
boolean |
RAID group is degraded. A RAID group is degraded when at least one disk from that group has failed or is offline. |
disks |
array[raid_group_disk] |
|
name |
string |
RAID group name |
raid_type |
string |
RAID type of the raid group. |
recomputing_parity |
||
reconstruct |
resync
Name | Type | Description |
---|---|---|
active |
boolean |
Plex is being resynchronized to its mirrored plex |
level |
string |
Plex resyncing level |
percent |
integer |
Plex resyncing percentage |
plex
Name | Type | Description |
---|---|---|
aggregate |
Aggregate |
|
name |
string |
Plex name |
online |
boolean |
Plex is online |
pool |
string |