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

列出所有磁碟區

PDF

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

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

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

包括

字串

查詢

錯誤

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

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

OpenAPI 範例："id"

  • 範例：id、name

限制

字串

查詢

錯誤

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

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

項目

array[任何： "volume_1.2_get_response_body"、array[]]

True

中繼資料

"type_astra_metadata_list"

True
範例回應 
{
  "type": "application/astra-volumes",
  "version": "1.2",
  "items": [
    [
      "24fe6e79-bf8d-45c9-96af-ef1d11fbd4a0",
      "myVolume"
    ],
    [
      "20a370f4-957f-446a-9126-08853d01933a",
      "secondVol"
    ],
    [
      "48e349a2-5bcd-4c59-896c-12b8240e634b",
      "smallVol"
    ]
  ],
  "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"
}

定義

請參閱定義

additionalDetails

type_astra_stateDetail

Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

additionalDetails

"additionalDetails"

錯誤

type_astra_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata

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

  • 符合 Astra 中繼資料架構

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

True

建立時間戳記

字串

True

修改時間戳記

字串

True

建立者

字串

True

modifiedBy

字串

錯誤

volume_1.2_get_response_body

Name 類型 必要 說明

類型

字串

True

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

  • "application/astra-volume"

版本

字串

True

資源版本。定義的值為：

  • "1.0"

  • "1.1"

  • "1.2"

ID

字串

True

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

  • 符合 UUIDv4 架構

姓名

字串

True

包含磁碟區名稱的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：255

狀態

字串

錯誤

JSON 字串，包含指示磁碟區運作狀態的值。

尺寸

字串

錯誤

包含磁碟區大小的 JSON 字串。

已使用

數字

錯誤

包含已佈建磁碟區所用配額位元組數的 JSON 數字。

usedPercentage

數字

錯誤

包含已使用磁碟區百分比的 JSON 數字。

總計

數字

錯誤

包含已配置磁碟區總位元組數的 JSON 數字。

creationToken

字串

錯誤

包含磁碟區建立權杖的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：255

snapshotPossible

字串

錯誤

指示驅動程式是否可以對磁碟區執行快照的 JSON 字串。定義的值為：

  • "true" - 驅動程式可以對磁碟區進行快照

  • "false" - 驅動程式無法對磁碟區進行快照

storageClass

字串

錯誤

包含磁碟區儲存類別的 JSON 字串。

  • 定義的值為：

  • 最短長度：1

  • 最大長度：255

pvcName

字串

錯誤

包含磁碟區 PersistentVolumeClaim （PVC）名稱的 JSON 字串。

  • 定義的值為：

  • 最短長度：1

  • 最大長度：255

internalName

字串

錯誤

包含目標儲存叢集上磁碟區的內部名稱（如果可用）的 JSON 字串。此名稱從 Kubernetes CSI 驅動程式取得。

  • 定義的值為：

  • 最短長度：1

  • 最大長度：255

appsUsing

陣列［string］

True

包含多個 JSON 字串的 JSON 陣列，每個字串包含正在使用該磁碟區的應用程式的 ID。定義的值為：

  • 符合 Astra 識別符架構

storageBackendID

字串

錯誤

包含提供該磁碟區的儲存後端 ID 的 JSON 字串。定義的值為：

  • 符合 Astra 識別符架構

協調器

字串

錯誤

包含此磁碟區協調器的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為：

  • 「trident」－ Trident 已配置此磁碟區

  • "vasa" - NetApp VASA Provider 已配置此磁碟區

  • 「其他」- 磁碟區已手動配置，或協調器未知

serviceLevel

字串

錯誤

包含儲存後端層級為此磁碟區定義的服務品質（QoS）策略的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。

exportPolicy

字串

錯誤

包含與此磁碟區關聯的匯出原則的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。

nodeId

字串

錯誤

包含磁碟區所在節點 ID 的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為：

  • 符合 Astra 識別符架構

healthState

字串

錯誤

包含指示磁碟區健全狀態值的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為：

  • 「不確定」- 無法判斷資源的健全狀況 （例如，由於缺乏連線能力）

  • 「normal」- 資源沒有已知問題，可依據介面規格提供服務

  • 「警告」- 該資源有已知問題，但這並不妨礙其依照介面規範提供服務

  • 「critical」- 此資源有已知問題，導致其無法依照介面規格提供服務

healthStateDetails

陣列["type_astra_stateDetail"]

True

包含 JSON 物件的 JSON 陣列，其中列出了有關目前健全狀況的其他詳細資訊。如果沒有可用的詳細資料，此陣列將為空白。

  • 最低項目數：0

中繼資料

"type_astra_metadata"

True

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

  • 符合 Astra 中繼資料架構

type_astra_metadata_list

Name 類型 必要 說明

繼續

字串

錯誤

數

數字

錯誤

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因