Get Cluster Details

The API to retrieve detailed information about a specific cluster given the cluster name.

Request Structure

Endpoint: /kube-get-cluster-details
Type: GET
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-get-cluster-details?name=<cluster_name>&gwsource=<gwsource>

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Table 1. Input Parameter
Name Description
sessionId

Header

 (Mandatory) A unique identifier assigned to a user's session upon successful authentication. The session ID remains valid until it expires, and it can contain alphanumeric characters.

Type: String

Constraints: The session ID is used when username and password are not provided.

Example: A1B2c3d4E5F6
gwsource

Header

 (Mandatory) Source from which the request is triggered.

Type: String

Example: DataCenterA
clusterName

String

 Name of the cluster.

Response Structure

Name Description
response

String

 The response contains the cluster details.
message

String

 Success message or failure description in case of error.
appStatusCode

String

 Application specific status code for the response. Will be non-null for failure response.
tags More info in case of failure response.

Sample Response

Sample Response 
{
    "response": {
        "clusterID": "e0c40779-55d4-434c-aadc-17c6463ba8e9",
        "clusterName": "cluster-01",
        "certOrchestratorNamespace": "crypto-mesh",
        "keywords": [
            "cluster-01",
            "Self-Managed",
            "crypto-mesh",
            "default",
            "kube-node-lease",
            "kube-system",
            "kube-public",
        ],
        "state": "Managed",
        "status": "Unhealthy",
        "vendor": "Self-Managed",
        "discoveryDefaultGroupName": "Default",
        "createdBy": "admin",
        "createdDateTime": 1716800271978,
        "lastModifiedTime": 1716963662484,
        "lastUpdatedTime": "05/28/2024 10:59:36",
        "namespaces": [
            "crypto-mesh",
            "default",
            "kube-node-lease",
            "kube-system",
            "kube-public"
        ],
        "nodes": [
            {
                "hostName": "cluster-01",
                "type": "master",
                "version": "v1.28.3"
            }
        ],
        "totalNodes": [
            {
                "hostName": "cluster-01",
                "type": "master",
                "version": "v1.28.3"
            }
        ],
        "numberOfNodes": 1,
        "numberOfPods": 10,
        "appViewXAuthSecretName": "appviewx-auth",
        "appViewXAuthSecretNamespace": "crypto-mesh",
        "credentialType": "Basic Authentication",
        "appViewXURL": "https://{appviewx-fqdn}/"
        "clientId": "",
        "collectionName": "<collection_name>",
        "isDiscoveryEnabled": true,
        "isPrivateKeyDiscoveryRequired": true,
        "isInfraOrchestratorEnabled": true,
        "isAppViewXCSIProviderEnabled": true,
        "isSignerEnabled": true
    },
    "message": null,
    "appStatusCode": null,
    "tags": null,
    "headers": null
}

Reference

Understanding the sample URL: This section provides an explanation of each component of the sample URL structure used in API requests. For quick reference, this section is referenced in all the API topics as Reference in this guide.
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.

What's New