Back to guides list

15.8. Showing Kubernetes cluster details

GET /v1/clusters/{cluster_ident}

Show details of a Kubernetes cluster with the specified ID.

Source: https://docs.openstack.org/api-ref/container-infrastructure-management/?expanded=#show-details-of-a-cluster

15.8.1. Request

Name In Type Description
cluster_ident path string The UUID or name of clusters in Magnum.

15.8.1.1. Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<..>' \
https://<node_IP_addr>:9513/v1/clusters/01d0583d-e8b3-483f-896f-08d2260b0dea

15.8.2. Response

Name In Type Description
status body string The current state of the bay/cluster.
uuid body UUID The UUID of the cluster.
links body array Links to the resources in question.
stack_id body UUID The reference UUID of orchestration stack from Heat orchestration service.
created_at body string

The date and time when the resource was created.

The date and time stamp format is ISO 8601:

CCYY-MM-DDThh:mm:ss±hh:mm

For example, 2015-08-27T09:49:58-05:00.

The ±hh:mm value, if included, is the time zone as an offset from UTC.
api_address body string The endpoint URL of COE API exposed to end-users.
discovery_url body string

The custom discovery url for node discovery. This is used by the COE to discover the servers that have been created to host the containers. The actual discovery mechanism varies with the COE. In some cases, Magnum fills in the server info in the discovery service. In other cases, if the discovery_url is not specified, Magnum will use the public discovery service at:

https://discovery.etcd.io

In this case, Magnum will generate a unique url here for each bay and store the info for the servers.
updated_at body string

The date and time when the resource was updated.

The date and time stamp format is ISO 8601:

CCYY-MM-DDThh:mm:ss±hh:mm

For example, 2015-08-27T09:49:58-05:00.

The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00.

If the updated_at date and time stamp is not set, its value is null.
master_count body integer The number of servers that will serve as master for the bay/cluster. The default is 1. Set to more than 1 master to enable High Availability. If the option master-lb-enabled is specified in the baymodel/cluster template, the master servers will be placed in a load balancer pool.
coe_version body string Version info of chosen COE in bay/cluster for helping client in picking the right version of client.
keypair body string The name of the SSH keypair to configure in the bay/cluster servers for ssh access. Users will need the key to be able to ssh to the servers in the bay/cluster. The login name is specific to the bay/cluster driver, for example with fedora-atomic image, default login name is fedora.
cluster_template_id body UUID The UUID of the cluster template.
master_addresses body array List of floating IP of all master nodes.
node_count body integer The number of servers that will serve as node in the bay/cluster. The default is 1.
node_addresses body array List of floating IP of all servers that serve as node.
status_reason body string The reason of bay/cluster current status.
create_timeout body integer The timeout for cluster creation in minutes. The value expected is a positive integer and the default is 60 minutes. If the timeout is reached during cluster creation process, the operation will be aborted and the cluster status will be set to CREATE_FAILED.
name body string Name of the resource.

15.8.2.1. Status codes

15.8.2.1.1. Success

Code Reason
200 - OK Request was successful.

15.8.2.1.2. Error

Code Reason
401 - Unauthorized User must authenticate before making a request.
403 - Forbidden Policy does not allow current user to do this operation.
404 - Not Found The requested resource could not be found.

15.8.2.2. Example

{
  "create_timeout": 60,
  "links": [
    {
      "href": "https://<node_IP_addr>:9513/v1/clusters/01d0583d-e8b3-483f-896f-08d2260b0dea",
      "rel": "self"
    },
    {
      "href": "https://<node_IP_addr>:9513/clusters/01d0583d-e8b3-483f-896f-08d2260b0dea",
      "rel": "bookmark"
    }
  ],
  "labels": {
    "kube_tag": "v1.15.6",
    "cloud_provider_enabled": "true",
    "cloud_provider_tag": "v1.15.0",
    "kube_version": "v1.15.6",
    "boot_volume_type": "default",
    "flannel_tag": "v0.11.0-amd64",
    "boot_volume_size": "10",
    "heat_container_agent_tag": "hci-3.5-latest",
    "docker_volume_type": "default"
  },
  "updated_at": "2020-04-11T20:17:49+00:00",
  "keypair": "key1",
  "master_flavor_id": "medium",
  "health_status_reason": {
    "k8s1-fwhg7cuxplnc-master-1.Ready": "True",
    "api": "ok",
    "k8s1-fwhg7cuxplnc-master-0.Ready": "True",
    "k8s1-fwhg7cuxplnc-minion-0.Ready": "True"
  },
  "user_id": "2a55cfc7747b4383b0856a0a622914dd",
  "uuid": "01d0583d-e8b3-483f-896f-08d2260b0dea",
  "api_address": "https://10.94.129.74:6443",
  "master_addresses": [
    "10.94.129.77",
    "10.94.129.75"
  ],
  "node_count": 1,
  "project_id": "888ea5e76b284d83a18b3bfaa6fdde16",
  "status": "CREATE_COMPLETE",
  "docker_volume_size": 10,
  "template_delete_on_termination": true,
  "master_count": 2,
  "node_addresses": [
    "10.94.129.79"
  ],
  "status_reason": "Stack CREATE completed successfully",
  "coe_version": "v1.15.6",
  "cluster_template_id": "4aceb259-3799-4a6a-85ef-7f9857b41462",
  "name": "k8s1",
  "stack_id": "dbfad3ec-2caf-43ef-839b-3c8dc0bdb1f8",
  "created_at": "2020-04-11T19:54:55+00:00",
  "discovery_url": "https://discovery.etcd.io/ffc39d4a95a6ca0abec545a506fd298d",
  "health_status": "HEALTHY",
  "flavor_id": "small",
  "container_version": "1.12.6"
}
Version 5.0.0 — Feb 01, 2022
Print