Retrieves a list of OpenStack machines

GET 
/v1/cloudconfigs/openstack/:configUid/machinePools/:machinePoolName/machines

Retrieves a list of OpenStack machines

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An array of OpenStack machine items

application/json

Schema

Schema

items object[]required
Array [
kindstring
metadata object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set
property name*string
creationTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
labels object
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
property name*string
lastModifiedTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
namestring
Name of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
spec object
OpenStack cloud VM definition spec
azstring
imagestring
instanceType objectrequired
Instance flavor of the machine with cpu and memory info
diskGiBint32
DiskGiB is the size of a virtual machine's disk, in GiB
memoryMiBint64
MemoryMiB is the size of a virtual machine's memory, in MiB
namestring
numCPUsint32
NumCPUs is the number of virtual processors in a virtual machine
nics object[]required
Array [
indexint8
networkNamestringrequired
privateIPsstring[]
]
projectIdstring
securityGroupsstring[]
sshKeyNamestring
status object
cloud machine status
health object
Machine health state
conditions object[]
Array [
messagestring
reasonstring
statusstring
typestring
]
lastHeartBeatTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
statestring
instanceStatestring
Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]
maintenanceStatus object
Machine maintenance status
actionstring
messagestring
statestring
]

Example (from schema)

{
  "items": [
    {
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.364Z",
        "deletionTimestamp": "2023-12-01T21:31:48.364Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.364Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "az": "string",
        "image": "string",
        "instanceType": {
          "diskGiB": 0,
          "memoryMiB": 0,
          "name": "string",
          "numCPUs": 0
        },
        "nics": [
          {
            "index": 0,
            "networkName": "string",
            "privateIPs": [
              "string"
            ]
          }
        ],
        "projectId": "string",
        "securityGroups": [
          "string"
        ],
        "sshKeyName": "string"
      },
      "status": {
        "health": {
          "conditions": [
            {
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "lastHeartBeatTimestamp": "2023-12-01T21:31:48.364Z",
          "state": "string"
        },
        "instanceState": "Pending",
        "maintenanceStatus": {
          "action": "string",
          "message": "string",
          "state": "string"
        }
      }
    }
  ]
}

Loading...