管理対象クラスタのクラスタノードを一覧表示する
GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/clusterNodes
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
managedCluster_id |
string |
path(パス) |
True |
包含するmanagedClusterリソースのID |
含める |
string |
query |
False |
コレクションを一覧表示する際に、どのフィールドを返すかを指定します。 URLの例:"include=id"、"include=id,name" OpenAPI の例:"id"
|
制限( Limit ) |
string |
query |
False |
コレクションを一覧表示する際に返されるリソースの最大数を示します。 URLの例:"limit=2" OpenAPI の例:"2" |
応答
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"clusterNode_1.0_get_response_body"、配列[]] |
True |
|
メタデータ |
True |
回答例
{
"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"
}
}
応答
Status: 401, Unauthorized
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
応答
Status: 400, Bad request
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
配列["invalidParams"] |
False |
無効なクエリパラメータのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
応答
Status: 403, Forbidden
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
エラー
Status: 404, Not found
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
エラー応答の例
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
用語の意味
定義を参照
ラベル
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
ラベル名を含むJSON文字列。定義済みの値は次のとおりです:
|
Value |
string |
True |
ラベル値を含むJSON文字列。定義済みの値は次のとおりです:
|
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astraメタデータスキーマに準拠
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
True |
||
作成タイムスタンプ |
string |
True |
|
modificationTimestamp |
string |
True |
|
作成者 |
string |
True |
|
modifiedBy |
string |
False |
clusterNode_1.0_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
名前 |
string |
True |
ノードのKubernetes名を示す値を含むJSON文字列。定義された値は次のとおりです:
|
ロール |
string |
True |
ノードのKubernetesロールを示す値を含むJSON文字列。定義された値は次のとおりです:
|
ラベル |
配列["ラベル"] |
True |
JSONオブジェクトのJSON配列。各JSONオブジェクトには、ノードに関連付けられたKubernetesラベルが含まれています。詳細情報が利用できない場合、この配列は空になります。
|
creationTime |
string |
True |
ノードが作成された日時を示すISO 8601タイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
externalIP |
string |
True |
ノードの内部IPアドレスを示す値を含むJSON文字列。定義された値は次のとおりです:
|
internalIP |
string |
True |
ノードの外部IPアドレスを示す値を含むJSON文字列。定義された値は次のとおりです:
|
ゾーン |
string |
True |
ノードのKubernetesゾーンを示す値を含むJSON文字列。定義された値は次のとおりです:
|
リージョン |
string |
True |
ノードのKubernetesリージョンを示す値を含むJSON文字列。定義された値は次のとおりです:
|
instanceType |
string |
True |
ノードのKubernetesインスタンスタイプを示す値を含むJSON文字列。定義された値は次のとおりです:
|
kernelVersion |
string |
True |
ノードで使用されているカーネルバージョンを示す値を含むJSON文字列。定義された値は次のとおりです:
|
osImage |
string |
True |
ノードが使用するオペレーティングシステムイメージを示す値を含むJSON文字列。定義された値は次のとおりです:
|
numCpus |
string |
True |
ノードに割り当てられたCPUの数を示す値を含むJSON文字列。定義された値は次のとおりです:
|
memory |
string |
True |
ノードに割り当てられたメモリ量を示す値を含むJSON文字列。定義された値は次のとおりです:
|
状態 |
string |
True |
ノードの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
type_astra_metadata_list
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
続行 |
string |
False |
|
カウント |
番号 |
False |
|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |