為託管叢集擷取磁碟區
GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/volumes/{volume_id}
在 JSON 回應本文中傳回已儲存的 Volume API 資源。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
包含帳戶資源的 ID
|
managedCluster_id |
字串 |
路徑 |
True |
包含 managedCluster 資源的 ID |
volume_id |
字串 |
路徑 |
True |
要列出的磁碟區集合 ID |
回應
Status: 200, Returns the stored Volume API resource in the JSON response body.
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。定義的值為:
|
ID |
字串 |
True |
資源的全域唯一識別碼。定義的值為:
|
姓名 |
字串 |
True |
包含磁碟區名稱的 JSON 字串。定義的值為:
|
狀態 |
字串 |
錯誤 |
JSON 字串,包含指示磁碟區運作狀態的值。 |
尺寸 |
字串 |
錯誤 |
包含磁碟區大小的 JSON 字串。 |
已使用 |
數字 |
錯誤 |
包含已佈建磁碟區所用配額位元組數的 JSON 數字。 |
usedPercentage |
數字 |
錯誤 |
包含已使用磁碟區百分比的 JSON 數字。 |
總計 |
數字 |
錯誤 |
包含已配置磁碟區總位元組數的 JSON 數字。 |
creationToken |
字串 |
錯誤 |
包含磁碟區建立權杖的 JSON 字串。定義的值為:
|
snapshotPossible |
字串 |
錯誤 |
指示驅動程式是否可以對磁碟區執行快照的 JSON 字串。定義的值為:
|
storageClass |
字串 |
錯誤 |
包含磁碟區儲存類別的 JSON 字串。
|
pvcName |
字串 |
錯誤 |
包含磁碟區 PersistentVolumeClaim (PVC)名稱的 JSON 字串。
|
internalName |
字串 |
錯誤 |
包含目標儲存叢集上磁碟區的內部名稱(如果可用)的 JSON 字串。此名稱從 Kubernetes CSI 驅動程式取得。
|
appsUsing |
陣列[string] |
True |
包含多個 JSON 字串的 JSON 陣列,每個字串包含正在使用該磁碟區的應用程式的 ID。定義的值為:
|
storageBackendID |
字串 |
錯誤 |
包含提供該磁碟區的儲存後端 ID 的 JSON 字串。定義的值為:
|
協調器 |
字串 |
錯誤 |
包含此磁碟區協調器的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為:
|
serviceLevel |
字串 |
錯誤 |
包含儲存後端層級為此磁碟區定義的服務品質(QoS)策略的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。 |
exportPolicy |
字串 |
錯誤 |
包含與此磁碟區關聯的匯出原則的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。 |
nodeId |
字串 |
錯誤 |
包含磁碟區所在節點 ID 的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為:
|
healthState |
字串 |
錯誤 |
包含指示磁碟區健全狀態值的 JSON 字串。此字串將針對 Astra Data Store 磁碟區進行定義。定義的值為:
|
healthStateDetails |
True |
包含 JSON 物件的 JSON 陣列,其中列出了有關目前健全狀況的其他詳細資訊。如果沒有可用的詳細資料,此陣列將為空白。
|
|
中繼資料 |
True |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
範例回應
{
"type": "application/astra-volume",
"version": "1.2",
"id": "ab5c9fb8-ddba-526f-8bd3-8d5b72cf4f7f",
"name": "myVolume",
"state": "ready",
"size": "512 GiB",
"used": 10000000000,
"usedPercentage": 10,
"total": 10000000000,
"creationToken": "ba7d4e0c-6ae3-4b6e-859d-9463e7ca4b4e",
"snapshotPossible": "true",
"storageClass": "gold",
"pvcName": "myVolume",
"internalName": "trident_sd234234_23424_897d_876sd65w",
"appsUsing": [],
"orchestrator": "trident",
"serviceLevel": "gold",
"exportPolicy": "astra-vp-default",
"nodeId": "94d16dd2-9beb-4edb-ab58-1a00e9a90052",
"healthState": "normal",
"healthStateDetails": [],
"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 |
錯誤 |
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
符合 Astra 中繼資料架構
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
True |
||
建立時間戳記 |
字串 |
True |
|
修改時間戳記 |
字串 |
True |
|
建立者 |
字串 |
True |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |