Skip to main content
Version: latest

Returns the specified virtual machine

GET 
https://api.spectrocloud.com/v1/cloudconfigs/virtual/:configUid/machinePools/:machinePoolName/machines/:machineUid

Returns the specified virtual machine

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

    machinePoolName stringrequired

    Machine pool name

    machineUid stringrequired

    Machine uid

Header Parameters

    ProjectUid string

    A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources

Responses​

OK

Schema
    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

    Virtual cloud machine definition spec

    hostnamestring
    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

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header
curl -L 'https://api.spectrocloud.com/v1/cloudconfigs/virtual/:configUid/machinePools/:machinePoolName/machines/:machineUid' \
-H 'Accept: application/json' \
-H 'ApiKey: <ApiKey>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— pathrequired
— pathrequired
— header