Returns the specified AWS machine

GET 
/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName/machines/:machineUid

Returns the specified AWS machine

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

machineUid stringrequired

Machine uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

apiVersionstring
kindstring

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

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

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

AWS cloud VM definition spec

additionalSecurityGroups

object[]

Additional Security groups

Array [

arnstring

ARN of resource

filters

object[]

Filters is a set of key/value pairs used to identify a resource

Array [

namestring

Name of the filter. Filter names are case-sensitive

valuesstring[]

Values includes one or more filter values. Filter values are case-sensitive

]

idstring

ID of resource

]

amistringrequired

azstring

dnsNamestring

iamProfilestring

instanceTypestringrequired

nics

object[]

Array [

indexint8

privateIPsstring[]

publicIpstring

]

phasestring

sshKeyNamestring

subnetIdstring

typestring

vpcIdstringrequired

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)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:57.252Z",
    "deletionTimestamp": "2024-07-02T18:20:57.252Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:57.252Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "additionalSecurityGroups": [
      {
        "arn": "string",
        "filters": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "id": "string"
      }
    ],
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-02T18:20:57.252Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}

Loading...