Get Cluster Stats

Get Cluster Stats

Api to get kubernetes Cluster Stats for Telco Cloud Automation

Request
URI
GET
https://{api_host}/tca/caas/api/v2/orgs/{orgId}/clusters/{clusterUUID}/stats
COPY
Path Parameters
string
orgId
Optional

The identifier of the tenant

string
clusterUUID
Optional

UUID of the cluster whose stats has to be retrieved

Query Parameters
string
mgmtClusterName
Optional

Name of the management cluster which is managing the cluster

string
tcaCpId
Optional

Id of the TCA CP where the request has to be routed.


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully accepted request to get cluster stats.

Returns clusterStats of type(s) application/json
{
    "id": "string",
    "metadata": {
        "resourceVersion": "number",
        "name": "string",
        "mgmtClusterName": "string",
        "tcaCpId": "string",
        "createdByIntent": "string",
        "modifiedByIntent": "string"
    },
    "apiVersion": "string",
    "status": {
        "clusterUrl": "string",
        "resourceVersion": "number",
        "opstatus": "string",
        "deleteAccepted": false,
        "vimId": "string",
        "conditions": [
            {
                "lastTransitionTime": "string",
                "status": "string",
                "type": "string",
                "reason": "string",
                "message": "string",
                "severity": "string"
            }
        ]
    },
    "stats": {
        "cluster": {
            "isProcessing": false,
            "hasError": false,
            "clusterUpgradeStatus": "string",
            "controlPlaneUpgradeStatus": "string"
        },
        "nodepools": {
            "total": 0,
            "ready": 0,
            "processing": 0,
            "nodePoolWithSupportedVersion": 0
        },
        "addons": {
            "total": 0,
            "ready": 0,
            "processing": 0
        }
    },
    "lastUpdated": "string",
    "creationDate": "string",
    "creationTenantId": "string",
    "creationUser": "string",
    "intentQueued": false
}
string
id
Optional

the identifier of the cluster

object
metadata
Optional

metadata

string
apiVersion
Optional

APIVersion defines the versioned schema of this representation of an object

object
status
Optional

status

object
stats
Optional

Node Pool ad Addon status of cluster

string
lastUpdated
Optional

Last Updated Date and Time of cluster

string
creationDate
Optional

Creation Date and Time of cluster

string
creationTenantId
Optional

creationTenantId

string
creationUser
Optional

Creation user of cluster

boolean
intentQueued
Optional

Flag to indicate if the Request is Queued


400
Returns BadRequest of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


404
Returns NotFound of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


409
Returns Conflict of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


500
Returns InternalServerError of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors