列出所有儲存貯體
GET /accounts/{account_id}/topology/v1/buckets
傳回集合中所有符合資源的 JSON 陣列。如果在請求中指定了個別欄位,則項目 JSON 陣列將按指定順序包含每個相符資源所請求的欄位。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
包含帳戶資源的 ID
|
回應
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[任何: "bucket_1.2_get_response_body"、array[]] |
True |
|
中繼資料 |
True |
範例回應
{
"type": "application/astra-buckets",
"version": "1.2",
"items": [
[
"4c753e39-25e9-4b36-a8de-69f168aa59cd",
"Test Bucket",
"gcp"
],
[
"d8fd585d-6429-4c08-a308-af193a88eac7",
"Local",
"ontap-s3"
]
],
"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 |
錯誤 |
s3
提供 Simple Storage Service(S3)協定參數的 JSON 物件。(此物件適用於所有 S3 類型提供者)。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
serverURL |
字串 |
True |
包含儲存貯體基礎路徑 URL 的 JSON 字串。定義的值為:
|
bucketName |
字串 |
True |
包含 S3 儲存貯體名稱的 JSON 字串。定義的值為:
|
gcp
提供 Google Cloud 通訊協定參數的 JSON 物件。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
bucketName |
字串 |
True |
包含底層 Google Cloud 儲存貯體名稱的 JSON 字串。定義的值為:
|
azure
提供 Azure 通訊協定參數的 JSON 物件。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
storageAccount |
字串 |
True |
包含 Azure 儲存體帳戶名稱的 JSON 字串。定義的值為:
|
bucketName |
字串 |
True |
包含後端 Azure Blob 名稱的 JSON 字串。定義的值為:
|
bucketParameters
此 JSON 物件提供存取儲存貯體所需的特定於儲存貯體提供者的資訊。此儲存貯體中的具體值因提供者而異。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
s3 |
錯誤 |
提供 Simple Storage Service(S3)協定參數的 JSON 物件。(此物件適用於所有 S3 類型提供者)。 |
|
gcp |
錯誤 |
提供 Google Cloud 通訊協定參數的 JSON 物件。 |
|
azure |
錯誤 |
提供 Azure 通訊協定參數的 JSON 物件。 |
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata_update
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定,元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
bucket_1.2_get_response_body
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。定義的值為:
|
ID |
字串 |
True |
資源的全域唯一識別碼。定義的值為:
|
姓名 |
字串 |
True |
包含使用者為儲存貯體指定的名稱的 JSON 字串。定義的值為:
|
credentialID |
字串 |
True |
包含用於存取儲存貯體的憑證識別碼的 JSON 字串。定義的值為:
|
狀態 |
字串 |
True |
包含指示儲存貯體運作狀態的值的 JSON 字串。定義的值為:
|
stateDetails |
True |
JSON 物件的 JSON 陣列,其中列出了有關「狀態」為何轉換為「已移除」或「失敗」的其他詳細資訊。如果沒有可用的詳細資料,此陣列將為空白。
|
|
供應商 |
字串 |
True |
JSON 字串,指示可用於存取儲存桶的儲存桶協定。定義的值為:
|
bucketParameters |
True |
此 JSON 物件提供存取儲存貯體所需的特定於儲存貯體提供者的資訊。此儲存貯體中的具體值因提供者而異。 |
|
中繼資料 |
True |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
type_astra_metadata_list
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
繼續 |
字串 |
錯誤 |
|
數 |
數字 |
錯誤 |
|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |