Skip to main content
A newer release of this product is available.

Retrieve a managed cluster

Contributors
PDFs

GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}

Returns the stored Managed Cluster API resource in the JSON response body.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

managedCluster_id

string

path

True

ID of the managedCluster collection to list

Response

Status: 200, Returns the stored Managed Cluster API resource in the JSON response body.
Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-managedCluster"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

  • "1.2"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a name for the cluster. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.

state

string

True

JSON string containing a value indicating the operational state of the cluster. Defined values are:

  • "pending" - The cluster is scheduled for discovery

  • "discovering" - The cluster is in the process of being discovered

  • "provisioning" - The cluster is in the process of being provisioned

  • "running" - The cluster is running normally

  • "failed" - The cluster is in a permanent failure state

  • "removed" - The cluster is not currently accessible

  • "unknown" - The cluster's state cannot be determined

restoreTargetSupported

string

False

JSON string containing a value indicating the managed cluster's ability to be a target of application data management operations. Defined values are:

  • "true" - Cluster is an eligible target for app data management operations.

  • "false" - Cluster is not an eligible target for app data management operations.

snapshotSupported

string

False

JSON string containing a value indicating the managed cluster's ability to perform application data management backup-like operations. Defined values are:

  • "true" - Cluster is an eligible to perform app data management operations.

  • "false" - Cluster is not eligible to perform app data management operations.

stateUnready

array[string]

True

JSON array of JSON strings, each indicating a reason why the cluster is unable to transition to "running" state, when there are issues while in "running" state, or why it has transitioned to the "failed" or "removed" state. Defined values are:

  • Minimum length: 1

  • Maximum length: 127

managedState

string

True

JSON string containing a value indicating the management state of the cluster. Defined values are:

  • "pending" - The cluster is scheduled to be discovered or added

  • "ineligible" - The cluster is in a "running" state, is not under management, and is not eligible for management. The reason or reasons for this ineligibility are provided in the unready key's value

  • "unmanaged" - The cluster is in a "running" or "failed" state, is not under management, and is eligible for management

  • "managing" - The cluster is in a "running" state and is in the process of being managed

  • "managed" - The cluster is in a "running", "failed", or "removed" state and is under management

protectionState

string

True

JSON string containing a value indicating the protection state of the cluster. Defined values are:

  • "full" - The cluster's default storage class supports snapshots

  • "partial" - The cluster has only storage classes that do not support snapshots

  • "atRisk" - The cluster's default storage class does not support snapshots

protectionStateDetails

array[type_astra_stateDetail]

True

JSON array of JSON objects that lists additional details about the current protection state, including why the current state was reached. If no details are available, this array will be empty. Defined values are:

  • Minimum Items: 0

managedStateUnready

array[string]

True

JSON array of JSON strings, each indicating a reason why the cluster is ineligible to be managed. Defined values are:

  • Minimum length: 1

  • Maximum length: 127

managedTimestamp

string

True

JSON string containing the timestamp indicating when the cluster was brought under management. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema This key is only returned when a cluster has a managedState of "managed".

tridentVersion

string

False

JSON string containing the version of Trident installed on the cluster. Defined values are:

  • Conforms to the Software Version Schema

tridentManagedState

string

False

JSON string containing one of a set of enumerated values indicating the management state of Trident on this cluster. Defined values are:

  • "managed" - Trident instance on the cluster is managed by Astra

  • "unmanaged" - Trident instance on the cluster is not managed by Astra

tridentManagedStateDesired

string

False

JSON string containing a value indicating the desired management state for Trident. Defined values are:

  • "managed" - Manage Trident on this cluster

  • "unmanaged" - Do not manage Trident on this cluster

tridentManagedStateDetails

array[type_astra_stateDetail]

False

JSON array of JSON objects that lists additional details about why "state" transitioned to "managed" or "unmanaged".
If no details are available, this array will be empty.

  • Minimum Items: 0

tridentManagedStateAllowed

array[string]

False

States that can be requested in a given tridentManagedState. The following states can be requested in each defined state:

  • "managed": "managed"

  • "unmanaged": "unmanaged"

inUse

string

True

JSON string containing a value indicating whether the cluster has any managed applications and therefore cannot be deleted. Defined values are:

  • "false" - The cluster is not managed, or it is managed but has no managed applications associated with it

  • "true" - The cluster is managed and has managed applications associated with it

accHost

string

False

JSON string that indicates that this cluster hosts the instance of Astra Control Center that is currently being accessed. Defined values are:

  • "true" - This cluster is hosting the instance of Astra Control Center that is currently being accessed.

clusterType

string

True

JSON string containing a value indicating the type of cluster. Defined values are:

  • "gke" - Kubernetes hosted on Google Kubernetes Engine

  • "aks" - Kubernetes hosted on Microsoft Azure Kubernetes Service

  • "eks" - Kubernetes hosted on Amazon Elastic Kubernetes Service

  • "rke" - The cluster is of type Rancher

  • "tanzu" -The cluster is of type Tanzu Kubernetes Grid

  • "openshift" - The cluster is of type OpenShift

  • "kubernetes" - The cluster is generic Kubernetes

clusterVersion

string

True

JSON string containing the semantic versioning representation of the cluster environment. For Kubernetes clusters, this is the Kubernetes version. Defined values are:

  • Minimum length: 1

  • Maximum length: 31

clusterVersionString

string

True

JSON string containing a value indicating the extended versioning information for the cluster environment. For Kubernetes clusters, this is the full Kubernetes version. Defined values are:

  • Minimum length: 1

  • Maximum length: 31

clusterCreationTimestamp

string

False

JSON string containing the timestamp indicating when the cluster was originally created. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

namespaces

array[string]

False

JSON array of JSON strings, each indicating a namespace within the cluster. Defined values are:

  • Minimum length: 1

  • Maximum length: 253

defaultStorageClass

string

False

JSON string containing a storage class ID that corresponds to the default storage class, as set in Kubernetes. Defined values are:

  • Conforms to the Astra Identifier Schema If not included, it has not yet been discovered.

cloudID

string

True

JSON string containing a value indicating the ID of the cloud the cluster is running on. Defined values are:

  • Conforms to the Astra Identifier Schema

credentialID

string

False

JSON string containing a value indicating the ID of the credential that contains the kubeconfig file for the cluster. Defined values are:

  • Conforms to the Astra Identifier Schema

location

string

False

JSON string containing a value provided by the cloud the cluster is running on, indicating the cloud-specific location of the cluster. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

isMultizonal

string

True

JSON string containing a value provided by the cloud the cluster is running on, indicating whether the cluster spans two or more availability zones. Defined values are:

  • "true" - The cluster spans two or more availability zones

  • "false" - The cluster is wholly located within a single availability zone

privateRouteID

string

False

JSON string containing the locationID for private clusters.

  • Minimum length: 1

  • Maximum length: 255

apiServiceID

string

False

JSON string containing the UUID from the Kubernetes (k8s) api service object. Used to uniquely identify a cluster.

metadata

type_astra_metadata_update

True

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.
Example response 
{
  "type": "application/astra-managedCluster",
  "version": "1.2",
  "id": "6f2fa469-cdae-54be-a451-d0e94a47fa62",
  "name": "GKE-22",
  "state": "running",
  "stateUnready": [],
  "managedState": "managed",
  "managedStateUnready": [],
  "managedTimestamp": "2020-08-06T12:24:52.256624Z",
  "protectionState": "full",
  "protectionStateDetails": [],
  "tridentVersion": "21.07.2",
  "tridentManagedState": "managed",
  "tridentManagedStateDesired": "managed",
  "tridentManagedStateDetails": [],
  "inUse": "true",
  "clusterType": "kubernetes",
  "clusterVersion": "1.91.1",
  "clusterVersionString": "1.19.1",
  "clusterCreationTimestamp": "2020-08-06T12:24:52.256624Z",
  "namespaces": [
    "kube-system",
    "kube-public",
    "my-app-1"
  ],
  "defaultStorageClass": "e280ff62-be35-4f31-a31b-a210a1ad1b33",
  "cloudID": "548bdc1f-f00e-4a23-a062-83265d224d46",
  "credentialID": "055e365a-2215-40de-aecb-a4070a7e6f1e",
  "location": "europe-west4",
  "isMultizonal": "false",
  "apiServiceID": "6bf33af2-872a-4553-a891-26b510c3edbe",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_stateDetail

Name Type Required Description

type

string

True

title

string

True

detail

string

True

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name Type Required Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid