Skip to main content

Retrieves a list of AWS machines

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

Retrieves a list of AWS machines

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

    machinePoolName stringrequired

    Machine pool name

Query Parameters

    fields string

    Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

    filters string

    Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

    Server will be restricted to certain fields based on the indexed data for each resource.

    orderBy string

    Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

    limit int64

    Default value: 50

    limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

    offset int64

    offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

    continue string

    continue token to paginate the subsequent data items

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

An array of AWS machine items

Schema

    items

    object[]

    required

  • Array [

    • 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

    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

  • ]

    • listmeta

    object

    ListMeta describes metadata for the resource listing

    continuestring

    Next token for the pagination. Next token is equal to empty string indicates end of result set.

    countinteger

    Total count of the resources which might change during pagination based on the resources addition or deletion

    limitinteger

    Number of records feteched

    offsetinteger

    The next offset for the pagination. Starting index for which next request will be placed.

Loading...