Getting Information About a Cluster

You can get information about the clusters you have created.

Getting Information About Your Clusters Using OKS CLI

To get information about your clusters, use the cluster get command following this syntax:

Request sample
$ oks-cli cluster get \
    --project-name NAME_OF_PROJECT \
    --cluster-name NAME_OF_CLUSTER

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

  • cluster-name: The name of the cluster, with a maximum length of 40 alphanumeric characters and dashes (-). This name must not start or end with a dash, and it must be unique within the project.

  • (optional) project-name: The name of the project containing the cluster you want to retrieve information from.

  • (optional) output: The output format for the response (json| yaml). By default, the response format is JSON.

Response sample
{
    "project_id": "12ca0d38-2927-4cf1-93de-049135f88f00",
    "id": "ee46b46c-c20a-4c56-a791-74e523ec17ae",
    "name": "NAME_OF_CLUSTER",
    "description": "null",
    "cp_multi_az": false,
    "cp_subregions": [
        "2a"
    ],
    "version": "1.30",
    "cni": "cilium",
    "admin_lbu": false,
    "admission_flags": {
        "disable_admission_plugins": [],
        "enable_admission_plugins": [],
        "applied_admission_plugins": [
            "ValidatingAdmissionPolicy",
            "PodSecurity",
            "DefaultTolerationSeconds",
            "Priority",
            "CertificateSubjectRestriction",
            "CertificateSigning",
            "CertificateApproval",
            "ServiceAccount",
            "TaintNodesByCondition",
            "DefaultStorageClass",
            "StorageObjectInUseProtection",
            "ValidatingAdmissionWebhook",
            "DefaultIngressClass",
            "PersistentVolumeClaimResize",
            "RuntimeClass",
            "ClusterTrustBundleAttest",
            "NamespaceLifecycle",
            "ResourceQuota",
            "MutatingAdmissionWebhook",
            "LimitRanger"
        ]
    },
    "cidr_pods": "10.91.0.0/16",
    "cidr_service": "10.92.0.0/16",
    "cluster_dns": "10.92.0.10",
    "tags": {},
    "auto_maintenances": {
        "minor_upgrade_maintenance": {
            "enabled": true,
            "duration_hours": 1,
            "start_hour": 12,
            "week_day": "Tue",
            "tz": "UTC"
        },
        "patch_upgrade_maintenance": {
            "enabled": true,
            "duration_hours": 1,
            "start_hour": 12,
            "week_day": "Tue",
            "tz": "UTC"
        }
    },
    "control_planes": "cp.mono.master",
    "admin_whitelist": [
        "1.2.3.4/32",
        "5.6.7.8/32"
    ],
    "statuses": {
        "created_at": "2025-01-01T00:02:00.000000Z",
        "deleted_at": null,
        "updated_at": "2025-01-01T00:02:00.000001Z",
        "status": "ready",
        "available_upgrade": ""
    },
    "disable_api_termination": false
}

Related Pages

Corresponding API Method

Export to PDF