Returns the specified CoxEdge machine

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

Returns the specified CoxEdge 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

Deprecated. Not used for the resource info.

kindstring

Deprecated. Cloud type of the machine.

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.

spec

object

CoxEdge cloud VM definition spec

addAnycastIpAddressboolean

deployments

undefined[]

Array [

cpuUtilizationint32

enableAutoScalingboolean

instancesPerPopint32

maxInstancesPerPopint32

minInstancesPerPopint32

namestring

popsstring[]

]

imagestring

persistentStorages

object[]

Array [

pathstring

Coxedge load persistent storage path

sizeint64

Coxedge load persistent storage size

]

ports

object[]

Array [

protocolstring

publicPortstring

publicPortDescstring

]

providerIdstring

specsstring

sshAuthorizedKeysstring[]

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-04-16T17:49:00.221Z",
    "deletionTimestamp": "2024-04-16T17:49:00.221Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-04-16T17:49:00.221Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "addAnycastIpAddress": true,
    "deployments": [
      {
        "cpuUtilization": 0,
        "enableAutoScaling": true,
        "instancesPerPop": 0,
        "maxInstancesPerPop": 0,
        "minInstancesPerPop": 0,
        "name": "string",
        "pops": [
          "string"
        ]
      }
    ],
    "image": "string",
    "persistentStorages": [
      {
        "path": "string",
        "size": 0
      }
    ],
    "ports": [
      {
        "protocol": "string",
        "publicPort": "string",
        "publicPortDesc": "string"
      }
    ],
    "providerId": "string",
    "specs": "string",
    "sshAuthorizedKeys": [
      "string"
    ]
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-04-16T17:49:00.221Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}

Loading...