Retrieves a list of AWS machines
GET/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName/machines
Retrieves a list of AWS machines
Request
Path Parameters
Cluster's cloud config uid
Machine pool name
Query Parameters
Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name
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.
Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1
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 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 token to paginate the subsequent data items
Header Parameters
Scope the request to the specified project uid
Responses
- 200
An array of AWS machine items
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
Array [
]
]
items
object[]
required
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
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.
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
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.
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
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
ARN of resource
filters
object[]
Filters is a set of key/value pairs used to identify a resource
Name of the filter. Filter names are case-sensitive
Values includes one or more filter values. Filter values are case-sensitive
ID of resource
nics
object[]
status
object
cloud machine status
health
object
Machine health state
conditions
object[]
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.
Possible values: [Pending
, Provisioning
, Provisioned
, Running
, Deleting
, Deleted
, Failed
, Unknown
]
maintenanceStatus
object
Machine maintenance status
listmeta
object
ListMeta describes metadata for the resource listing
Next token for the pagination. Next token is equal to empty string indicates end of result set.
Total count of the resources which might change during pagination based on the resources addition or deletion
Number of records feteched
The next offset for the pagination. Starting index for which next request will be placed.
{
"items": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-29T15:51:28.071Z",
"deletionTimestamp": "2024-07-29T15:51:28.071Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
"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-29T15:51:28.071Z",
"state": "string"
},
"instanceState": "Pending",
"maintenanceStatus": {
"action": "string",
"message": "string",
"state": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": 0,
"limit": 0,
"offset": 0
}
}