DescribeCluster

Describes a Kubernetes cluster.

get/api/org/v1/clusters/{cluster}

Path Parameters

• cluster ^required

  A Kubernetes cluster ID.

  • Schema ResourceId
  • Type string
  • Minimum Length 1
  • Maximum Length 20
  • Pattern ^[A-Z0-9]+$

Query Parameters

This operation does not have query parameters.

Request Body

This operation does not have a request body.

Responses

200 Response

The information about the cluster is returned.

• Schema Cluster
• Type object
• Properties

  • id ^required

    The cluster ID.

    • Schema ResourceId

  • name ^required

    The cluster name.

    • Schema ResourceName

  • kubeClusterConfig ^required

    The Kubernetes cluster configuration.

    • Schema KubeClusterConfiguration

  • createdAt ^required

    The time when the cluster was created.

    • Type string
    • Format date-time

  • updatedAt ^required

    The time when the cluster was last updated.

    • Type string
    • Format date-time

400 Response

The requested operation cannot be performed because the request is malformed.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

401 Response

The requested operation cannot be performed because the request lacks valid authentication credentials.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

403 Response

The identity is not allowed to perform the requested operation for the resource involved.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

404 Response

The resource or dependent resources involved in the requested operation do not exist.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

Default Response

The requested operation failed with an error.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string