Skip to main content

List the cluster nodes for a cluster

Contributors
PDFs

GET /accounts/{account_id}/topology/v1/clusters/{cluster_id}/clusterNodes

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

cluster_id

string

path

True

ID of the containing cluster resource

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

  • example: name,instanceType

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name Type Required Description

items

array[Any of: clusterNode_1.0_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True
Example response 
{
  "type": "application/astra-clusterNodes",
  "version": "1.0",
  "items": [
    [
      "test-0",
      "e2-medium"
    ],
    [
      "test-1",
      "e2-medium"
    ],
    [
      "test-2",
      "e2-medium"
    ],
    [
      "test-3",
      "e2-micro"
    ]
  ],
  "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

labels

Name Type Required Description

name

string

True

JSON string containing the label name Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • Defined regex is: "^([\S.]{1,253}\/)?([a-z0-9A-Z_.-]){1,63}$"

value

string

True

JSON string containing the label value Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • Defined regex is: "^([a-z0-9A-Z_.-]){1,63}$"

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata

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

  • Conforms to the Astra Metadata Schema

Name Type Required Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

modifiedBy

string

False

clusterNode_1.0_get_response_body

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-clusterNode"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a value that indicates the Kubernetes name for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

role

string

True

JSON string containing a value that indicates the Kubernetes role for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

labels

array[labels]

True

JSON array of JSON objects, each containing Kubernetes labels associated with the node. If no details are available, this array will be empty.

  • Minimum items: 0

creationTime

string

True

JSON string containing an ISO 8601 timestamp that indicates when the node was created. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

externalIP

string

True

JSON string containing a value that indicates the internal IP address for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

internalIP

string

True

JSON string containing a value that indicates the external IP address for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

zone

string

True

JSON string containing a value that indicates the Kubernetes zone for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

region

string

True

JSON string containing a value that indicates the Kubernetes region for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

instanceType

string

True

JSON string containing a value that indicates the Kubernetes instance type for the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

kernelVersion

string

True

JSON string containing a value that indicates the kernel version used by the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

osImage

string

True

JSON string containing a value that indicates the operating system image used by the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

numCpus

string

True

JSON string containing a value that indicates the number of CPUs assigned to the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

memory

string

True

JSON string containing a value that indicates the amount of memory assigned to the node. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

state

string

True

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

  • "running" - The node is running normally

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

  • "discovering" - Aspects of the node are in the process of being discovered

  • "pending" - The node is scheduled for discovery

  • "failed" - The node is in a failure state

  • "unknown" - The state of the node cannot be determined

metadata

type_astra_metadata

True

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

  • Conforms to the Astra Metadata Schema

type_astra_metadata_list

Name Type Required Description

continue

string

False

count

number

False

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