Skip to main content
REST API reference
A newer release of this product is available.

Retrieve a plex specified by the aggregate UUID and plex name

PDFs

GET /storage/aggregates/{aggregate.uuid}/plexes/{name}

Introduced In: 9.6

Retrieves the plex specified by the aggregate UUID and plex name.

  • storage aggregate plex show

Parameters

Name Type In Required Description

aggregate.uuid

string

path

True

Aggregate UUID

name

string

path

True

Plex name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

aggregate

aggregate

Aggregate

name

string

Plex name

online

boolean

Plex is online

pool

string

SyncMirror pool assignment

raid_groups

array[raid_group]

resync

resync

state

string

Plex state
Example response 
{
  "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

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

self

href

aggregate

Aggregate

Name Type Description

_links

_links

name

string

uuid

string

disk

Disk

Name Type Description

_links

_links

name

string

raid_group_disk

Name Type Description

disk

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

recomputing_parity

reconstruct

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

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

target

string

The target parameter that caused the error.