Skip to main content
23.07
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

管理対象クラスターを取得する

PDF

GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}

JSONレスポンスボディに格納されているマネージドクラスタAPIリソースを返します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

managedCluster_id

string

path（パス）

True

リストするmanagedClusterコレクションのID

応答

Status: 200, Returns the stored Managed Cluster API resource in the JSON response body.
Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • 「application/astra-managedCluster」

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

  • "1.2"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

クラスター名を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • この文字列は、XSS攻撃、Unicode攻撃、ディレクトリトラバーサル攻撃、SQLインジェクション攻撃を防ぐために内部的に検証されます。

状態

string

True

クラスターの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「pending」 - クラスターの検出が予定されています

  • 「discovering」 - クラスタの検出処理中です

  • 「provisioning」 - クラスタのプロビジョニング処理中です

  • 「running」 - クラスターは正常に動作しています

  • 「failed」 - クラスタが永続的な障害状態にあります

  • 「削除済み」 - クラスターには現在アクセスできません

  • 「不明」 - クラスタの状態を判断できません

restoreTargetSupported

string

False

管理対象クラスタがアプリケーションデータ管理操作の_ターゲット_となる能力を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「true」 - クラスタは、アプリケーションデータ管理処理の対象として適格です。

  • 「false」 - クラスタは、アプリケーションデータ管理処理の対象として適格では_ありません_。

snapshotSupported

string

False

管理対象クラスタがアプリケーションデータ管理のバックアップのような操作を実行できるかどうかを示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「true」 - クラスタは、アプリケーションデータ管理操作を実行する資格があります。

  • 「false」 - クラスタは、アプリケーションデータ管理処理を実行する資格が_ありません_。

stateUnready

array[string]

True

JSON文字列のJSON配列。各文字列は、クラスターが「実行中」状態に移行できない理由、「実行中」状態中に問題が発生した場合、または「失敗」状態や「削除済み」状態に移行した理由を示します。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：127

managedState

string

True

クラスターの管理状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「pending」 - クラスターは検出または追加される予定です

  • 「ineligible」 - クラスタは「running」状態であり、管理下になく、管理の対象外です。この不適格性の理由は、unreadyキーの値に示されています。

  • 「管理対象外」 - クラスターは「実行中」または「障害発生」状態であり、管理対象外ですが、管理対象にすることができます

  • 「管理中」 - クラスタは「実行中」状態であり、管理処理中です

  • 「managed」 - クラスタは「running」、「failed」、または「removed」状態であり、管理下にあります

protectionState

string

True

クラスターの保護状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「full」 - クラスタのデフォルトのストレージクラスはスナップショットをサポートします

  • 「partial」 - クラスタには、スナップショットをサポートしないストレージクラスのみが存在します

  • "atRisk" - クラスターのデフォルトのストレージクラスはスナップショットをサポートしていません

protectionStateDetails

配列["type_astra_stateDetail"]

True

現在の保護状態に関する詳細情報（現在の状態に至った理由を含む）を一覧表示するJSONオブジェクトのJSON配列。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

managedStateUnready

array[string]

True

JSON文字列のJSON配列。各文字列は、クラスターが管理対象外である理由を示しています。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：127

managedTimestamp

string

True

クラスターが管理下に置かれた日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです：

  • ISO-8601 日付時刻スキーマに準拠 このキーは、クラスタのmanagedStateが「managed」の場合にのみ返されます。

tridentVersion

string

False

クラスタにインストールされているTridentのバージョンを含むJSON文字列。定義された値は次のとおりです：

  • ソフトウェアバージョンスキーマに準拠

tridentManagedState

string

False

このクラスタ上の Trident の管理状態を示す列挙値のセットの 1 つを含む JSON 文字列。定義された値は次のとおりです：

  • 「managed」 - クラスタ上の Trident インスタンスは Astra によって管理されます

  • 「管理されていない」 - クラスター上のTridentインスタンスはAstraによって管理されていません

tridentManagedStateDesired

string

False

Tridentの目的の管理状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「managed」 - このクラスター上でTridentを管理する

  • 「unmanaged」 - このクラスター上でTridentを管理しない

tridentManagedStateDetails

配列["type_astra_stateDetail"]

False

「state」が「managed」または「unmanaged」に移行した理由に関する詳細情報をリストしたJSONオブジェクトのJSON配列。+ 詳細情報が利用できない場合、この配列は空になります。

  • 最小アイテム数：0

tridentManagedStateAllowed

array[string]

False

特定のtridentManagedStateで要求できる状態。各定義済み状態において、以下の状態を要求することができます：

  • "managed"："managed"

  • "unmanaged"："管理対象外"

inUse

string

True

クラスターに管理対象アプリケーションが存在するかどうか、つまり削除できないかどうかを示す値を含む JSON 文字列。定義された値は次のとおりです：

  • 「false」 - クラスターは管理されていないか、管理されているが、関連付けられている管理対象アプリケーションがない

  • 「true」 - クラスターは管理されており、管理対象アプリケーションが関連付けられています

accHost

string

False

このクラスタが現在アクセスされているAstra Control Centerのインスタンスをホストしていることを示すJSON文字列。定義された値は次のとおりです：

  • 「true」 - このクラスタは、現在アクセスされているAstra Control Centerのインスタンスをホストしています。

clusterType

string

True

クラスターの種類を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「gke」- Google Kubernetes Engine 上でホストされる Kubernetes

  • 「aks」 - Microsoft Azure Kubernetes Service 上でホストされている Kubernetes

  • 「eks」 - Amazon Elastic Kubernetes Service でホストされる Kubernetes

  • 「rke」 - クラスタのタイプは Rancher です

  • 「tanzu」 - クラスタのタイプは Tanzu Kubernetes Grid です

  • "openshift" - クラスタのタイプはOpenShift

  • 「kubernetes」 - クラスタは汎用Kubernetesです

clusterVersion

string

True

クラスタ環境のセマンティックバージョニング表現を含むJSON文字列。Kubernetesクラスタの場合、これはKubernetesバージョンです。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：31

clusterVersionString

string

True

クラスタ環境の拡張バージョン情報を示す値を含むJSON文字列。Kubernetesクラスタの場合、これは完全なKubernetesバージョンです。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：31

clusterCreationTimestamp

string

False

クラスターが最初に作成された日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

ネームスペース

array[string]

False

JSON文字列のJSON配列。各文字列は、クラスター内の名前空間を示します。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：253

defaultStorageClass

string

False

Kubernetesで設定されているデフォルトのストレージクラスに対応するストレージクラスIDを含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠します。含まれていない場合は、まだ検出されていません。

cloudID

string

True

クラスターが実行されているクラウドのIDを示す値を含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

credentialID

string

False

クラスタのkubeconfigファイルを含むクレデンシャルのIDを示す値を含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

場所

string

False

クラスターが実行されているクラウドから提供される値を含むJSON文字列。この値は、クラスターのクラウド固有の場所を示します。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

isMultizonal

string

True

クラスターが実行されているクラウドから提供される値を含むJSON文字列。この値は、クラスターが2つ以上の可用性ゾーンにまたがっているかどうかを示します。定義された値は次のとおりです：

  • 「true」 - クラスタが2つ以上のアベイラビリティゾーンにまたがっている

  • 「false」 - クラスタは単一のアベイラビリティゾーン内に完全に配置されています

privateRouteID

string

False

プライベートクラスタのlocationIDを含むJSON文字列。

  • 最小長さ：1

  • 最大長さ：255

apiServiceID

string

False

Kubernetes (k8s) APIサービスオブジェクトから取得したUUIDを含むJSON文字列。クラスターを一意に識別するために使用されます。

メタデータ

"type_astra_metadata_update"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
回答例 
{
  "type": "application/astra-managedCluster",
  "version": "1.2",
  "id": "6f2fa469-cdae-54be-a451-d0e94a47fa62",
  "name": "GKE-22",
  "state": "running",
  "stateUnready": [],
  "managedState": "managed",
  "managedStateUnready": [],
  "managedTimestamp": "2020-08-06T12:24:52.256624Z",
  "protectionState": "full",
  "protectionStateDetails": [],
  "tridentVersion": "21.07.2",
  "tridentManagedState": "managed",
  "tridentManagedStateDesired": "managed",
  "tridentManagedStateDetails": [],
  "inUse": "true",
  "clusterType": "kubernetes",
  "clusterVersion": "1.91.1",
  "clusterVersionString": "1.19.1",
  "clusterCreationTimestamp": "2020-08-06T12:24:52.256624Z",
  "namespaces": [
    "kube-system",
    "kube-public",
    "my-app-1"
  ],
  "defaultStorageClass": "e280ff62-be35-4f31-a31b-a210a1ad1b33",
  "cloudID": "548bdc1f-f00e-4a23-a062-83265d224d46",
  "credentialID": "055e365a-2215-40de-aecb-a4070a7e6f1e",
  "location": "europe-west4",
  "isMultizonal": "false",
  "apiServiceID": "6bf33af2-872a-4553-a891-26b510c3edbe",
  "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

"additionalDetails"

False

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由