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

Retrieve a chassis

Contributors
PDFs

GET /cluster/chassis/{id}

Introduced In: 9.6

Retrieves a specific chassis.

  • system chassis show

  • system chassis fru show

Learn more

Parameters

Name Type In Required Description

id

string

path

True

Chassis ID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

frus

array[frus]

List of FRUs in the chassis.

id

string

nodes

array[nodes]

List of nodes in the chassis.

shelves

array[shelf_reference]

List of shelves in chassis.

state

string
Example response 
{
  "frus": [
    {
      "id": "string",
      "state": "string",
      "type": "string"
    }
  ],
  "id": "021352005981",
  "nodes": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "position": "top",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "shelves": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "uid": "7777841915827391056"
    }
  ],
  "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

frus

Name Type Description

id

string

state

string

type

string

href

Name Type Description

href

string

_links

Name Type Description

self

href

nodes

Name Type Description

_links

_links

name

string

position

string

The position of the node in the chassis.

uuid

string

shelf_reference

Shelf

Name Type Description

_links

_links

uid

string

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.