List the cluster nodes for a cloud
GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}/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
|
cloud_id |
string |
path |
True |
ID of the containing cloud resource |
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"
|
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 |
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 |
False |
|
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 |
False |
|
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 |
False |
|
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 |
False |
|
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:
|
value |
string |
True |
JSON string containing the label value Defined values are:
|
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:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
name |
string |
True |
JSON string containing a value that indicates the Kubernetes name for the node. Defined values are:
|
role |
string |
True |
JSON string containing a value that indicates the Kubernetes role for the node. Defined values are:
|
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.
|
creationTime |
string |
True |
JSON string containing an ISO 8601 timestamp that indicates when the node was created. Defined values are:
|
externalIP |
string |
True |
JSON string containing a value that indicates the internal IP address for the node. Defined values are:
|
internalIP |
string |
True |
JSON string containing a value that indicates the external IP address for the node. Defined values are:
|
zone |
string |
True |
JSON string containing a value that indicates the Kubernetes zone for the node. Defined values are:
|
region |
string |
True |
JSON string containing a value that indicates the Kubernetes region for the node. Defined values are:
|
instanceType |
string |
True |
JSON string containing a value that indicates the Kubernetes instance type for the node. Defined values are:
|
kernelVersion |
string |
True |
JSON string containing a value that indicates the kernel version used by the node. Defined values are:
|
osImage |
string |
True |
JSON string containing a value that indicates the operating system image used by the node. Defined values are:
|
numCpus |
string |
True |
JSON string containing a value that indicates the number of CPUs assigned to the node. Defined values are:
|
memory |
string |
True |
JSON string containing a value that indicates the amount of memory assigned to the node. Defined values are:
|
state |
string |
True |
JSON string containing a value indicating the operational state of the node. Defined values are:
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
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 |