Sign in

Get information about infrastructures

get/infrastructures

Query parameters

namestring

Filter infrastructures by name

tagsstring[]

Filter infrastructures by tag

{"stackTrail":"paths:/infrastructures:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Get list of object names instead of full objects

{"stackTrail":"paths:/infrastructures:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Fold expandable objects

{"stackTrail":"paths:/infrastructures:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Report object types in YAML dumps

format'yaml' | 'json'

Select response format

Response

successful operation

descriptionstring

Text description of the infrastructure.

namestring

The name of the infrastructure.

tagsstring[]

List of tags associated to the infrastructure.

Example response

[
  {
    "description": "HPC cluster",
    "layout": [
      {
        "network": [
          {
            "name": "ethsw[01-10]",
            "rack": "A[01-10]",
            "slot": 30,
            "tags": [
              "ethernet",
              "switch"
            ],
            "type": "switch48"
          }
        ],
        "nodes": [
          {
            "name": "cn[001-0040]",
            "rack": "A[01-10]",
            "slot": 10,
            "tags": [
              "compute",
              "standard"
            ],
            "type": "server"
          }
        ],
        "rack": "A[01-10]",
        "storage": [
          {
            "name": "nas[01-04]",
            "rack": "A[01-10]",
            "slot": 20,
            "tags": [
              "storage",
              "nas"
            ],
            "type": "nas"
          }
        ],
        "tags": [
          "compute"
        ]
      }
    ],
    "name": "mercury",
    "tags": [
      "hpc"
    ]
  }
]

Changes