View Machine details
Requests
HTTP request
GET /apis/platform.tkestack.io/v1/machines/{name}
read the specified Machine
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | True | name of the Machine |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| exact | boolean | False | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
| export | boolean | False | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| pretty | string | False | If 'true', then the output is pretty printed. |
Responses
Content-Type
application/json,
application/yaml,
application/vnd.kubernetes.protobuf
Status code: 200
OK
Sample response
Machine instance in Kubernetes cluster
{
"apiVersion": "platform.tkestack.io/v1",
"kind": "Machine",
"metadata": {
"annotations": {
"cpaas.io/display-name": "192.168.0.104"
},
"creationTimestamp": "2021-06-24T02:25:45Z",
"name": "mc-192-168-0-104",
"resourceVersion": "2078561",
"selfLink": "/apis/platform.tkestack.io/v1/machines/mc-192-168-0-104",
"uid": "719f0a5b-a730-41e3-8c15-1572675b6423"
},
"spec": {
"clusterName": "global",
"displayName": "",
"finalizers": [
"machine"
],
"ip": "192.168.0.104",
"ipv6": "",
"networkDevice": "",
"port": 22,
"proxy": {},
"publicIP": "",
"role": "",
"type": "Baremetal",
"username": "root"
},
"status": {
"conditions": [
{
"lastProbeTime": "2021-07-01T09:14:06Z",
"lastTransitionTime": "2021-06-24T02:26:34Z",
"status": "True",
"type": "HealthCheck"
}
],
"machineInfo": {},
"phase": "Running"
}
}Parameters
| Name | Type | Description |
|---|---|---|
| apiVersion | string | See common parameters |
| kind | string | See common parameters |
| metadata | object | See common parameters |
| spec | object |
MachineSpec is a description of machine.
Path: spec |
| spec.clusterName | string |
cluster name
Path: spec.clusterName |
| spec.displayName | string |
displayName
Path: spec.displayName |
| spec.finalizers | array |
Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
Path: spec.finalizers |
| spec.finalizers[] | string |
Path: spec.finalizers[] |
| spec.ip | string |
ip
Path: spec.ip |
| spec.ipv6 | string |
ipv6
Path: spec.ipv6 |
| spec.networkDevice | string |
networkDevice
Path: spec.networkDevice |
| spec.port | integer (int32) |
port
Path: spec.port |
| spec.proxy | object |
MachineProxy is the proxy to connect Machine's ssh.
Path: spec.proxy |
| spec.publicIP | string |
publicIP
Path: spec.publicIP |
| spec.role | string |
master/node
Path: spec.role |
| spec.type | string |
type
Path: spec.type |
| spec.username | string |
user name
Path: spec.username |
| status | object |
MachineStatus represents information about the status of an machine.
Path: status |
| status.conditions | array |
machine condition
Path: status.conditions |
| status.conditions[] | object |
MachineCondition contains details for the current condition of this Machine.
Path: status.conditions[] |
| conditions[].lastProbeTime | string (date-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.
Path: status.conditions[].lastProbeTime |
| conditions[].lastTransitionTime | string (date-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.
Path: status.conditions[].lastTransitionTime |
| conditions[].status | string |
Status is the status of the condition. Can be True, False, Unknown.
Path: status.conditions[].status |
| conditions[].type | string |
Type is the type of the condition.
Path: status.conditions[].type |
| status.machineInfo | object |
MachineSystemInfo is a set of ids/uuids to uniquely identify the node.
Path: status.machineInfo |
| status.phase | string |
machine phase
Path: status.phase |