Retrieve a cluster node for a managed cluster
GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/clusterNodes/{clusterNode_id}
Returns the stored Cluster Node API resource in the JSON response body.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
managedCluster_id |
string |
path |
True |
ID of the containing managedCluster resource |
clusterNode_id |
string |
path |
True |
ID of the clusterNode collection to list |
Response
Status: 200, Returns the stored Cluster Node API resource in the JSON 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:
|
Example response
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
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
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
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
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 |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid query parameter |
reason |
string |
True |
Reason why the query parameter is invalid |