Overview

DescriptionRetrieve detailed information of all the hosts (slave nodes) in a specific Kubernetes-CoreOS Cluster.
Resource Path/kubernetesClusters/{kubernetesClusterId}/hosts
HTTP MethodGET
Request/Response Formatapplication/json
> GET /api/kubernetesClusters/kubernetes-cluster-1/hosts HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Mon, 06 Apr 2015 10:33:55 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
[{"hostId":"minion-1","hostname":"minion-1.dev.kubernetes.org","privateIPAddress":"172.17.8.102","publicIPAddress":"172.17.8.102"},{"hostId":"minion-2","hostname":"minion-2.dev.kubernetes.org","privateIPAddress":"172.17.8.103","publicIPAddress":"172.17.8.103"}] 
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/kubernetesCluster/{kubernetesClusterId}/hosts

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

For example:

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/kubernetesClusters/kubernetes-cluster-1/hosts

CLI command

list-kubernetes-hosts

DescriptionRetrieve all host details of a specific Kubernetes-CoreOS Cluster.
Command formatlist-kubernetes-hosts -c <CLUSTER_ID>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

[
  {
    "hostId": "minion-1",
    "hostname": "minion-1.dev.kubernetes.org",
    "privateIPAddress": "172.17.8.102",
    "publicIPAddress": "172.17.8.102"
  },
  {
    "hostId": "minion-2",
    "hostname": "minion-2.dev.kubernetes.org",
    "privateIPAddress": "172.17.8.103",
    "publicIPAddress": "172.17.8.103"
  }
]

For information on all the properties that can be used in a Kubernetes Host definition, see the Kubernetes Host Resource Definition.

  • No labels