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

列出所有雲端

PDF

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

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

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

包括

字串

查詢

錯誤

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

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

OpenAPI 範例："id"

  • 範例：id、name、state

限制

字串

查詢

錯誤

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

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[任何一項： "cloud_1.1_get_response_body"、array[]]

True

中繼資料

"type_astra_metadata_list"

True
範例回應 
{
  "type": "application/astra-clouds",
  "version": "1.1",
  "items": [
    [
      "2f9e63fa-8ba8-414a-a57c-0f3042b80682",
      "gcp",
      "discovering"
    ],
    [
      "f723febe-b167-44dd-b07d-c075a8bbe4f3",
      "aws",
      "failed"
    ]
  ],
  "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_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

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

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

cloud_1.1_get_response_body

Name 類型 必要 說明

類型

字串

True

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

  • "application/astra-cloud"

版本

字串

True

資源版本。已定義值包括：

  • "1.0"

  • "1.1"

ID

字串

True

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

  • 符合 UUIDv4 架構

姓名

字串

True

包含雲端名稱的 JSON 字串。已定義的值包括：

  • 最短長度：1

  • 最大長度：63

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

狀態

字串

True

包含指示雲端運作狀態值的 JSON 字串。已定義的值包括：

  • 「pending」— 雲端已排程進行探索

  • 「discovering」——雲正處於被發現的過程中

  • 「provisioning」－雲端正在佈建過程中

  • 「running」— Cloud 正常運作

  • 「失敗」- 雲端處於永久性故障狀態

  • "removed" - 雲端目前無法存取

  • 「未知」- 無法判斷雲端狀態

stateUnready

陣列［string］

True

包含多個 JSON 字串的 JSON 陣列，每個字串指示雲端無法轉換到「running」狀態或已轉換到「failed」狀態的原因。定義的值包括：

  • 最短長度：1

  • 最大長度：127

cloudType

字串

True

包含指示雲端類型值的 JSON 字串。已定義的值為：

  • 「gcp」— 雲端服務由 Google 提供。

  • 「azure」- 雲端由 Microsoft 提供

  • 「aws」- 雲端由 Amazon 提供

  • 「私有」－雲端由客戶管理

credentialID

字串

錯誤

JSON 字串包含一個值，該值指示包含雲端服務帳戶的憑證 ID。此值對於 cloudType "gcp"、"azure" 和 "aws" 是必要的。已定義的值包括：

  • 符合 Astra 識別符架構

defaultBucketID

字串

錯誤

包含儲存貯體 ID 的 JSON 字串，該儲存貯體將在為雲端應用程式建立備份時預設使用。跨叢集複製應用程式時需要此 ID，並且在建立備份和排程任務時如果未指定儲存貯體，則使用此 ID 作為預設值。已定義的值包括：

  • 符合 Astra 識別符架構

中繼資料

"type_astra_metadata_update"

True

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

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

type_astra_metadata_list

Name 類型 必要 說明

繼續

字串

錯誤

數

數字

錯誤

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因