Skip to main content
Astra Automation
此產品有較新版本可以使用。
本繁體中文版使用機器翻譯，譯文僅供參考，若與英文版本牴觸，應以英文版本為準。

列出所有叢集

PDF

GET /accounts/{account_id}/topology/v1/clusters

傳回集合中所有符合資源的 JSON 陣列。如果在請求中指定了個別欄位，則項目 JSON 陣列將按指定順序包含每個相符資源所請求的欄位。

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

包括

字串

查詢

錯誤

指示列出集合時應傳回哪些欄位。

URL 範例：「include=id」、「include=id,name」

OpenAPI 範例："id"

  • 範例：id、name、managedState

限制

字串

查詢

錯誤

表示列出集合時要傳回的資源數量上限。

URL 範例：「limit=2」

OpenAPI 範例：「2」

篩選器

字串

查詢

錯誤

指示在列出集合時，為了傳回資源而應符合哪些欄位。

支援的運算子包括：

  • eq - 等式

  • lt/gt - 小於/大於

  • lte/gte - 小於或等於/大於或等於

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 類型 必要 說明

項目

array[任何： "cluster_1.5_get_response_body"、array[]]

True

中繼資料

"type_astra_metadata_list"

True
範例回應 
{
  "type": "application/astra-clusters",
  "version": "1.5",
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidParams

陣列["invalidParams"]

錯誤

無效查詢參數清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

回應

Status: 403, Forbidden
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例錯誤回應 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

定義

請參閱定義

type_astra_stateDetail

Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

type_astra_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

cluster_1.5_get_response_body

Name 類型 必要 說明

類型

字串

True

資源的媒體類型。定義的值為：

  • "application/astra-cluster"

版本

字串

True

資源版本。定義的值為：

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

  • "1.4"

  • "1.5"

ID

字串

True

資源的全域唯一識別碼。定義的值為：

  • 符合 UUIDv4 架構

姓名

字串

True

包含叢集名稱的 JSON 字串。如果未指定，則將使用叢集的 Kubernetes 名稱。定義的值為：

  • 最短長度：1

  • 最大長度：63

  • 此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊

狀態

字串

True

包含指示叢集運作狀態值的 JSON 字串。定義的值為：

  • 「pending」- 叢集已排程進行探索

  • 「discovering」- 叢集正在探索過程中

  • 「 provisioning 」——叢集正在配置過程中

  • 「running」- 叢集運作正常

  • 「 failed 」－叢集處於永久故障狀態

  • "removed" - 該叢集目前無法存取

  • 「未知」- 無法判斷叢集狀態

stateUnready

陣列［string］

True

JSON 字串的 JSON 陣列，每個字串分別指示叢集無法轉換到「running」狀態的原因、叢集在「running」狀態下出現問題的原因，以及叢集轉換到「failed」或「removed」狀態的原因。定義的值為：

  • 最短長度：1

  • 最大長度：127

managedState

字串

True

包含指示叢集管理狀態值的 JSON 字串。定義的值為：

  • 「pending」- 叢集已排程等待探索或新增

  • 「不符合條件」- 叢集處於「運作」狀態，未被管理，且不符合管理條件。不符合條件的原因在 unready 鍵值中提供

  • 「未管理」 - 叢集處於「執行中」或「失敗」狀態，未受管理，且符合管理資格

  • 「managing」 - 叢集處於「running」狀態，且正在進行管理程序

  • 「managed」－叢集處於「running」、「failed」或「removed」狀態，並處於管理狀態。

protectionState

字串

True

包含指示叢集保護狀態值的 JSON 字串。定義的值為：

  • 「full」- 叢集的預設儲存類別支援快照

  • 「部分」－此叢集僅包含不支援快照的 storageClasses

  • "atRisk" - 叢集的預設儲存類別不支援快照

protectionStateDetails

陣列["type_astra_stateDetail"]

True

JSON 物件的 JSON 陣列，其中列出有關目前保護狀態的其他詳細資料，包括達到目前狀態的原因。如果沒有可用的詳細資料，此陣列將為空白。定義的值為：

  • 最低項目數：0

restoreTargetSupported

字串

錯誤

包含一個值的 JSON 字串，該值指示叢集是否能夠作為應用程式資料管理操作的目標。定義的值為：

  • "true" - 叢集是應用程式資料管理作業的合格目標。

  • 「 false 」 - 叢集_不_是應用程式資料管理作業的合格目標。

snapshotSupported

字串

錯誤

包含一個值的 JSON 字串，該值指示叢集執行類似應用程式資料管理備份作業的能力。定義的值為：

  • "true" - 叢集有資格執行應用程式資料管理作業。

  • 「false」- 叢集_不_符合執行應用程式資料管理作業的資格。

managedStateUnready

陣列［string］

True

JSON 字串的 JSON 陣列，每個字串都指出叢集不符合管理資格的原因，或叢集已受管理但在管理叢集時遇到非致命錯誤。定義的值為：

  • 最短長度：1

  • 最大長度：127

managedTimestamp

字串

錯誤

包含叢集接管管理時間戳記的 JSON 字串。定義的值為：

  • 符合 ISO-8601 日期時間方案。僅當叢集具有 managedState 為「managed」時才會傳回此鍵。

tridentVersion

字串

錯誤

包含叢集上已安裝 Trident 版本的 JSON 字串。定義的值為：

  • 符合 Software Version Schema

tridentManagedState

字串

錯誤

包含一組列舉值之一的 JSON 字串，指示此叢集上 Trident 的管理狀態。定義的值為：

  • 「託管」- 叢集上的 Trident 執行個體由 Astra 管理

  • 「非託管」- 叢集上的 Trident 執行個體並非由 Astra 管理

tridentManagedStateDesired

字串

錯誤

JSON 字串包含一個值，指示 Trident 所需的管理狀態。定義的值為：

  • 「已管理」 - 管理此叢集上的 Trident

  • 「未管理」 - 請勿在此叢集上管理 Trident

tridentManagedStateDetails

陣列["type_astra_stateDetail"]

錯誤

JSON 物件的 JSON 陣列，其中列出了狀態轉換為「managed」或「unmanaged」原因的其他詳細資訊。+ 如果沒有可用的詳細資料，此陣列將為空白。

  • 最少項目數：0

tridentManagedStateAllowed

陣列［string］

錯誤

可在指定的 tridentManagedState 中請求的狀態。在每個已定義的狀態下，可以請求以下狀態：

  • "managed": "受管理"

  • 「unmanaged」：「unmanaged」

inUse

字串

True

JSON 字串包含一個值，指示叢集是否有任何託管應用程式，因此無法刪除。定義的值為：

  • 「false」- 叢集未受管理，或受管理但沒有與之關聯的受管理應用程式

  • 「true」- 叢集已受管，且有相關聯的受管應用程式

accHost

字串

錯誤

JSON 字串，指示此叢集託管目前正在存取的 Astra Control Center 執行個體。定義的值為：

  • "true" - 此叢集託管目前正在存取的 Astra Control Center 執行個體。

clusterType

字串

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

字串

錯誤

JSON 字串，包含指示叢集環境語意版本控制表示法的值。對於 Kubernetes 叢集，此字串表示 Kubernetes 版本。定義的值為：

  • 最短長度：1

  • 最大長度：31

clusterVersionString

字串

錯誤

JSON 字串，包含指示叢集環境擴充版本資訊的值。對於 Kubernetes 叢集，這是完整的 Kubernetes 版本。定義的值為：

  • 最短長度：1

  • 最大長度：31

clusterCreationTimestamp

字串

錯誤

包含叢集初始建立時間戳記的 JSON 字串。定義的值為：

  • 符合 ISO-8601 日期時間架構

命名空間

陣列［string］

錯誤

JSON 字串的 JSON 陣列，每個字串代表叢集中的一個命名空間。定義的值為：

  • 最短長度：1

  • 最大長度：253

defaultStorageClass

字串

錯誤

包含儲存類別 ID 的 JSON 字串，該 ID 對應於 Kubernetes 中設定的預設儲存類別。定義的值為：

  • 符合 Astra 識別符架構

cloudID

字串

True

包含叢集運行所在雲端平台 ID 的 JSON 字串。定義的值為：

  • 符合 Astra 識別符架構

credentialID

字串

錯誤

包含一個值的 JSON 字串，該值指示包含叢集 kubeconfig 檔案的憑證的 ID。定義的值為：

  • 符合 Astra Identifier Schema。如果提供了 privateRouteID 和 connectorCapabilities 且至少包含 relay 選項，則 credentialID 為可選。如果未提供這些項目，則 credentialID 為必要項，否則將產生錯誤。如果提供了 credentialID 和支援 relay 的連接器，則會產生錯誤。

位置

字串

錯誤

包含叢集運作所在雲端平台提供的值的 JSON 字串，指示叢集在該雲端平台上的具體位置。定義的值為：

  • 最短長度：1

  • 最大長度：63

isMultizonal

字串

錯誤

包含叢集運作所在雲端平台提供的值的 JSON 字串，指示叢集是否跨越兩個或多個可用區。定義的值為：

  • 「true」- 叢集跨越兩個或多個可用區域

  • "false" - 叢集完全位於單一可用區內

privateRouteID

字串

錯誤

包含私有叢集位置 ID 的 JSON 字串。

  • 最短長度：1

  • 最大長度：255

connectorCapabilities

陣列［string］

錯誤

與此叢集相關聯的連接器功能。為向後相容性而設為選用。如果不存在、則假設為 Proxy 功能。

apiServiceID

字串

錯誤

包含 Kubernetes（k8s）API 服務物件 UUID 的 JSON 字串。用於唯一識別叢集。

中繼資料

"type_astra_metadata_update"

True

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

type_astra_metadata_list

Name 類型 必要 說明

繼續

字串

錯誤

數

數字

錯誤

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因