クラウドのクラスターを一覧表示する
GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}/clusters
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
cloud_id |
string |
path(パス) |
True |
包含するクラウド リソースのID |
含める |
string |
query |
False |
コレクションを一覧表示する際に、どのフィールドを返すかを指定します。 URLの例:"include=id"、"include=id,name" OpenAPI の例:"id"
|
制限( Limit ) |
string |
query |
False |
コレクションを一覧表示する際に返されるリソースの最大数を示します。 URLの例:"limit=2" OpenAPI の例:"2" |
フィルタ |
string |
query |
False |
コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。 サポートされているオペレータは次のとおりです:
URLの例:"filter=field%20eq%20%27value%27" OpenAPI の例:「field eq 'value'」 |
応答
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"cluster_1.7_get_response_body"、配列[]] |
True |
|
メタデータ |
True |
回答例
{
"type": "application/astra-clusters",
"version": "1.7",
"items": [
[
"0f284377-e5dc-4dcd-bacd-3197f2b8a347",
"GKE-21",
"managed"
],
[
"04dc80fa-d1d8-4850-a49f-3b70d0ec1369",
"GKE-22",
"unmanaged"
]
],
"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"
}
用語の意味
定義を参照
additionalDetails
type_astra_stateDetail
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
additionalDetails |
False |
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata_update
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
cluster_1.7_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
名前 |
string |
True |
クラスター名を含むJSON文字列。指定がない場合は、クラスターのKubernetes名が使用されます。定義された値は次のとおりです:
|
状態 |
string |
True |
クラスターの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
stateUnready |
array[string] |
True |
JSON文字列のJSON配列。各文字列は、クラスターが「実行中」状態に移行できない理由、「実行中」状態中に問題が発生した場合、または「失敗」状態や「削除済み」状態に移行した理由を示します。定義された値は次のとおりです:
|
managedState |
string |
True |
クラスターの管理状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
managedStateDetails |
False |
現在の状態に関する詳細情報(現在の状態に至った理由を含む)をリストしたJSONオブジェクトのJSON配列。詳細情報がない場合は、この配列は空になります。定義された値は次のとおりです:
|
|
protectionState |
string |
True |
クラスターの保護状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
protectionStateDetails |
True |
現在の保護状態に関する詳細情報(現在の状態に至った理由を含む)を一覧表示するJSONオブジェクトのJSON配列。詳細情報が利用できない場合、この配列は空になります。定義値は次のとおりです:
|
|
restoreTargetSupported |
string |
False |
クラスターがアプリケーションデータ管理操作の_ターゲット_となる能力を示す値を含むJSON文字列。定義された値は次のとおりです:
|
snapshotSupported |
string |
False |
クラスターがアプリケーションデータ管理のバックアップのような操作を実行できるかどうかを示す値を含むJSON文字列。定義された値は次のとおりです:
|
managedStateUnready |
array[string] |
True |
JSON文字列のJSON配列。各文字列は、クラスターが管理対象とならない理由、またはクラスターは管理対象であるが、管理中に致命的ではないエラーが発生したことを示す。定義された値は次のとおりです:
|
managedTimestamp |
string |
False |
クラスターが管理下に置かれた日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
tridentVersion |
string |
False |
クラスタにインストールされているTridentのバージョンを含むJSON文字列。定義された値は次のとおりです:
|
acpVersion |
string |
False |
クラスタにインストールされているAstra Control Provisionerのバージョンを含むJSON文字列。定義された値は次のとおりです:
|
tridentManagedState |
string |
False |
このクラスタ上の Trident の管理状態を示す列挙値のセットの 1 つを含む JSON 文字列。定義された値は次のとおりです:
|
tridentManagedStateDesired |
string |
False |
Tridentの目的の管理状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
tridentManagedStateDetails |
False |
状態が「管理対象」または「管理対象外」に移行した理由に関する詳細情報をリストしたJSONオブジェクトのJSON配列。+ 詳細情報が利用できない場合、この配列は空になります。
|
|
tridentManagedStateAllowed |
array[string] |
False |
特定のtridentManagedStateで要求できる状態。各定義済み状態において、以下の状態を要求することができます:
|
inUse |
string |
True |
クラスターに管理対象アプリケーションが存在するかどうか、つまり削除できないかどうかを示す値を含むJSON文字列。定義値は次のとおりです:
|
accHost |
string |
False |
このクラスタが現在アクセスされているAstra Control Centerのインスタンスをホストしていることを示すJSON文字列。定義された値は次のとおりです:
|
clusterType |
string |
True |
クラスターの種類を示す値を含むJSON文字列。定義値は次のとおりです:
|
clusterVersion |
string |
False |
クラスタ環境のセマンティックバージョニング表現を示す値を含むJSON文字列。Kubernetesクラスタの場合、これはKubernetesのバージョンです。定義された値は次のとおりです:
|
clusterVersionString |
string |
False |
クラスタ環境の拡張バージョン情報を示す値を含むJSON文字列。Kubernetesクラスタの場合、これは完全なKubernetesバージョンです。定義された値は次のとおりです:
|
clusterCreationTimestamp |
string |
False |
クラスターが最初に作成された日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
ネームスペース |
array[string] |
False |
JSON文字列のJSON配列。各文字列は、クラスター内の名前空間を示します。定義された値は次のとおりです:
|
defaultStorageClass |
string |
False |
Kubernetesで設定されているデフォルトのストレージクラスに対応するストレージクラスIDを含むJSON文字列。定義された値は次のとおりです:
|
cloudID |
string |
True |
クラスターが実行されているクラウドのIDを示す値を含むJSON文字列。定義された値は次のとおりです:
|
credentialID |
string |
False |
クラスタのkubeconfigファイルを含むクレデンシャルのIDを示す値を含むJSON文字列。定義されている値は次のとおりです:
|
場所 |
string |
False |
クラスターが実行されているクラウドから提供される値を含むJSON文字列。この値は、クラスターのクラウド固有の場所を示します。定義値は次のとおりです:
|
isMultizonal |
string |
False |
クラスターが実行されているクラウドから提供される値を含むJSON文字列。この値は、クラスターが2つ以上の可用性ゾーンにまたがっているかどうかを示します。定義値は次のとおりです:
|
privateRouteID |
string |
False |
プライベートクラスタのロケーションIDを含むJSON文字列。
|
connectorCapabilities |
array[string] |
False |
このクラスタに関連付けられているコネクタの機能。下位互換性のためのオプション。存在しない場合は、プロキシが想定される機能となります。 |
apiServiceID |
string |
False |
Kubernetes(k8s)APIサービスオブジェクトからのUUIDを含む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 |
クエリパラメータが無効な理由 |