Overview

DescriptionRetrieve detailed information on a specific Kubernetes-CoreOS group.
Resource Path/kubernetesClusters/{kubernetesClusterId}
HTTP MethodGET
Request/Response Formatapplication/json
> GET /api/kubernetesClusters/kubernetes-cluster-1 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:02:56 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"clusterId":"kubernetes-cluster-1","description":"Kubernetes Cluster 1","kubernetesHosts":[{"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"}],"kubernetesMaster":{"hostId":"master","hostname":"master.dev.kubernetes.org","privateIPAddress":"172.17.8.101","publicIPAddress":"172.17.8.101"},"portRange":{"lower":4500,"upper":5000},"property":[{"name":"payload_parameter.MB_IP","value":"172.17.8.1"},{"name":"payload_parameter.MB_PORT","value":1883},{"name":"payload_parameter.CEP_IP","value":"172.17.8.1"},{"name":"payload_parameter.CEP_PORT","value":7711},{"name":"payload_parameter.LOG_LEVEL","value":"DEBUG"},{"name":"payload_parameter.METADATA_SERVICE_URL","value":"https:\/\/172.17.8.1:9443"}]} 
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/kubernetesClusters/{kubernetesClusterId}

  • 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

CLI command

describe-kubernetes-cluster

DescriptionRetrieve details of a Kubernetes-CoreOS Cluster.
Command format

describe-kubernetes-cluster <CLUSTER_ID>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

{
  "clusterId": "kubernetes-cluster-1",
  "description": "Kubernetes Cluster 1",
  "kubernetesHosts": [
    {
      "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"
    }
  ],
  "kubernetesMaster": {
    "hostId": "master",
    "hostname": "master.dev.kubernetes.org",
    "privateIPAddress": "172.17.8.101",
    "publicIPAddress": "172.17.8.101"
  },
  "portRange": {
    "lower": 4500,
    "upper": 5000
  },
  "property": [
    {
      "name": "payload_parameter.MB_IP",
      "value": "172.17.8.1"
    },
    {
      "name": "payload_parameter.MB_PORT",
      "value": 1883
    },
    {
      "name": "payload_parameter.CEP_IP",
      "value": "172.17.8.1"
    },
    {
      "name": "payload_parameter.CEP_PORT",
      "value": 7711
    },
    {
      "name": "payload_parameter.LOG_LEVEL",
      "value": "DEBUG"
    },
    {
      "name": "payload_parameter.METADATA_SERVICE_URL",
      "value": "https:\/\/172.17.8.1:9443"
    }
  ]
} 

For information on the property definitions, see the Kubernetes Cluster Resource Definition.

  • No labels