日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

Retrieve a cluster node for a cloud

10/21/2024 共同作成者

PDF

GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}/clusters/{cluster_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 example: {{.Account}}
cloud_id	string	path	True	ID of the containing cloud resource
cluster_id	string	path	True	ID of the containing cluster resource
clusterNode_id	string	path	True	ID of the clusterNode collection to list

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

cloud_id

string

path

True

ID of the containing cloud resource

cluster_id

string

path

True

ID of the containing cluster 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: "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

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"

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

Example response

{
  "type": "application/astra-clusterNode",
  "version": "1.0",
  "id": "5df0e09f-2c30-5b8a-b6b6-4fb4063525e4",
  "name": "test-0",
  "role": "node-role.kubernetes.io/worker",
  "labels": [],
  "creationTime": "2020-09-06T04:35:23.593845Z",
  "externalIP": "192.168.12.44",
  "internalIP": "10.0.1.1",
  "zone": "us-west1-c",
  "region": "us-east1",
  "instanceType": "e2-medium",
  "kernelVersion": "4.18.0-147.0.3.el8_1.x86_64",
  "osImage": "Red Hat Enterprise Linux CoreOS 42.81.20191203.0",
  "numCpus": "2",
  "memory": "67108864Ki",
  "state": "running",
  "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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

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

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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

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}$"

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

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
labels	array[type_astra_label]	True
creationTimestamp	string	True
modificationTimestamp	string	True
createdBy	string	True
modifiedBy	string	False

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

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

Retrieve a cluster node for a cloud

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions