Get Cluster Stats

Get Cluster Stats

Api to get kubernetes Cluster Stats for Telco Cloud Automation

Request
URI
GET
https://{api_host}/telco/api/caas/v2/clusters/{clusterName}/stats
COPY
Path Parameters
string
clusterName
Optional

Name 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
{
    "lastUpdated": "lastUpdated",
    "metadata": {
        "createdByIntent": "createdByIntent",
        "modifiedByIntent": "modifiedByIntent",
        "tcaCpId": "tcaCpId",
        "resourceVersion": 0.8008281904610115,
        "name": "name",
        "mgmtClusterName": "mgmtClusterName"
    },
    "apiVersion": "apiVersion",
    "creationUser": "creationUser",
    "stats": {
        "cluster": {
            "controlPlaneHasSupportedTbrVersion": true,
            "isProcessing": true,
            "clusterHasSupportedTbrVersion": true,
            "hasError": true
        },
        "nodepools": {
            "total": 1,
            "ready": 5,
            "processing": 5,
            "nodePoolWithSupportedVersion": 2
        },
        "addons": {
            "total": 7,
            "ready": 9,
            "processing": 3
        }
    },
    "creationDate": "creationDate",
    "status": {
        "deleteAccepted": true,
        "vimId": "vimId",
        "clusterUrl": "clusterUrl",
        "resourceVersion": 6.027456183070403,
        "opstatus": "processing",
        "conditions": [
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            },
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            }
        ]
    }
}
metadata
Optional

metadata

string
apiVersion
Optional

APIVersion defines the versioned schema of this representation of an object

status
Optional

status

stats
Optional

stats

string
lastUpdated
Optional

Last Updated Date and Time of cluster

string
creationDate
Optional

Creation Date and Time of cluster

string
creationUser
Optional

Creation user of cluster


400

Bad Request

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

errors


404

Resource request is not found

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

errors


409

Shall be returned when multiple clusters exist with same name. The response body shall contain a ErrorResponse structure, in which the "message" attribute shall convey more information about the error.

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

errors


500

Internal Server Error

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

errors