Retrieves a list of Generic machines
GET/v1/cloudconfigs/generic/:configUid/machinePools/:machinePoolName/machines
Retrieves a list of Generic 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 Generic machine items
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
items undefined[]required
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
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
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
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 of the resource
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
spec
Generic cloud VM definition spec
instanceType object
DiskGiB is the size of a virtual machine's disk, in GiB
MemoryMiB is the size of a virtual machine's memory, in MiB
NumCPUs is the number of virtual processors in a virtual machine
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": [
{
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2023-12-01T21:31:48.322Z",
"deletionTimestamp": "2023-12-01T21:31:48.322Z",
"labels": {},
"lastModifiedTimestamp": "2023-12-01T21:31:48.322Z",
"name": "string",
"uid": "string"
},
"spec": {
"hostName": "string",
"imageId": "string",
"instanceType": {
"diskGiB": 0,
"memoryMiB": 0,
"name": "string",
"numCPUs": 0
},
"nics": [
{
"index": 0,
"networkName": "string",
"privateIPs": [
"string"
],
"publicIp": "string"
}
],
"sshKeyName": "string"
},
"status": {
"health": {
"conditions": [
{
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"lastHeartBeatTimestamp": "2023-12-01T21:31:48.323Z",
"state": "string"
},
"instanceState": "Pending",
"maintenanceStatus": {
"action": "string",
"message": "string",
"state": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": 0,
"limit": 0,
"offset": 0
}
}