List Kubernetes Clusters

List Kubernetes Clusters

API code: LIST_KUBERNETES_CLUSTERS
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS

Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/k8s/clusters
COPY
Query Parameters
integer
offset
Optional

The start index of items to return for the current page.

integer
limit
Optional

The max count of items to return for the current page.

string
filter
Optional

The RSQL expression to filter page results based on property comparison.
The logical operations include:

  • Logical AND ';' or 'and'
  • Logical OR ',' or 'or'
The comparison operations include:
  • Equal to '=='
  • Not equal to '!='
  • Less than '=lt=' or '<'
  • Less than or equal to '=le=' or '<='
  • Greater than operator '=gt=' or '>'
  • Greater than or equal to '=ge=' or '>='
  • In '=in='
  • Not in '=out='
The logic operations can be grouped by parentheses:
  • (..)
  • (..);(..)
  • (..),(..)
To know which property supports which filter operators, please refer to the type resource, e.g. /api/v1/types/bucket.
Date property value format must be ISO8601 compliant, e.g. yyyy-MM-ddTHH:mm:ss.SSSZ. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D.
Examples:
  • lastModifiedDate<2018-10-14T02:36:08.262%2D0000
  • foo1=="value1" and foo2>value2
  • foo1=in=(value1,value2);foo2=out=(value3,value4,value5),foo3==value6*value7


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageCluster of type(s) application/json
{
    "items": [
        {
            "id": "string",
            "name": "string",
            "location": "string",
            "ownerName": "string",
            "ownerId": "string",
            "health": "string",
            "nodeCount": 0,
            "protectionStatus": "string",
            "bucket": "string",
            "protectedBy": "string",
            "protecting": false,
            "protectingRegion": "string",
            "nextBackup": 0,
            "errorMessages": [
                "string"
            ],
            "restoreStatus": {
                "phase": "string",
                "validationErrors": [
                    "string"
                ],
                "warnings": 0,
                "errors": 0,
                "failureReason": "string",
                "startTimestamp": "string",
                "completionTimestamp": "string",
                "totalItems": 0,
                "itemsRestored": 0
            },
            "appName": "string",
            "appId": "string",
            "status": "string",
            "creationDate": "string",
            "backupStorageLocation": {
                "name": "string",
                "bucket": "string",
                "region": "string",
                "caCert": "string",
                "sseS3": false,
                "status": "string"
            },
            "volumeSnapshotLocation": {
                "name": "string",
                "provider": "string",
                "config": {
                    "config": "string"
                }
            },
            "accessKey": "string",
            "storageUserId": "string",
            "schedule": {
                "metadata": {
                    "name": "string",
                    "namespace": "string",
                    "resourceVersion": "string",
                    "creationTimestamp": "string",
                    "annotations": {
                        "annotations": "string"
                    },
                    "labels": {
                        "labels": "string"
                    }
                },
                "spec": {
                    "template": {
                        "includedNamespaces": [
                            "string"
                        ],
                        "excludedNamespaces": [
                            "string"
                        ],
                        "includedResources": [
                            "string"
                        ],
                        "excludedResources": [
                            "string"
                        ],
                        "includeClusterResources": "string",
                        "orderedResources": "string",
                        "labelSelector": {
                            "labelSelector": "string"
                        },
                        "snapshotVolumes": false,
                        "ttl": "string",
                        "storageLocation": "string",
                        "volumeSnapshotLocations": [
                            "string"
                        ],
                        "advancedOptions": {
                            "advancedOptions": "string"
                        }
                    },
                    "schedule": "string"
                },
                "status": {
                    "phase": "string",
                    "lastBackup": "string",
                    "validationErrors": [
                        "string"
                    ]
                }
            },
            "supportSnapshotVolume": false,
            "message": "string",
            "statusUpdateDate": "string",
            "fullControl": false,
            "externalCluster": false,
            "orgName": "string",
            "k8sVersion": "string",
            "k8sProvider": "string"
        }
    ],
    "pageInfo": {
        "offset": 0,
        "limit": 0,
        "total": 0
    }
}
array of Cluster
items
Optional

items

pageInfo
Optional

pageInfo