Listing Your Clusters

You can list the clusters you have created. This action also returns information about their status and time of creation.

Listing Your Clusters

The cluster list command lists all available clusters and allows you to check their status. You can use it with the following syntax:

Request sample

$ oks-cli cluster list \
    --project-name NAME_OF_PROJECT \
    --output json

This command contains the following options that you may need to specify:

project-name: The name of the project containing the clusters that you want to list.
(optional) cluster-name: The name of the cluster.
(optional) deleted: The ability to list deleted clusters.
(optional) output: The output format for the response (json | yaml | wide).

Result sample

+-------------+-------------+--------------+------------+---------+
|     NAME    |   CREATED   |    UPDATED   |   STATUS   | DEFAULT |
+-------------+-------------+--------------+------------+---------+
|  my-cluster |  a day ago  |   a day ago  |   ready    |         |
+-------------+-------------+--------------+------------+---------+

You can add the -o wide option to your command to display more information about the listed clusters:

Result sample

+--------------------------------------+-------------+-------------+--------------+------------+---------+---------+--------------------+
|                  ID                  |     NAME    |   CREATED   |    UPDATED   |   STATUS   | DEFAULT | VERSION |   CONTROL PLANE    |
+--------------------------------------+-------------+-------------+--------------+------------+---------+---------+--------------------+
| ee46b46c-c20a-4c56-a791-74e523ec17ae |  my-cluster |  a day ago  |   a day ago  |   ready    |         |   1.31  | cp.3.masters.small |
+--------------------------------------+-------------+-------------+--------------+------------+---------+---------+--------------------+

Related Pages

Corresponding API Methods