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

建立新的儲存區

PDF

POST /accounts/{account_id}/topology/v1/buckets

指示要建立的 Bucket API 資源的期望值。

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

請求本文

指示要建立的 Bucket API 資源的期望值。

Name 類型 必要 說明

類型

字串

True

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

  • "application/astra-bucket"

版本

字串

True

資源版本。定義的值為：

  • "1.0"

  • "1.1"

  • "1.2"

姓名

字串

錯誤

包含使用者為儲存貯體指定的名稱的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：256

credentialID

字串

True

包含用於存取儲存貯體的憑證識別碼的 JSON 字串。定義的值為：

  • 符合 Astra 識別符架構

供應商

字串

True

JSON 字串，指示可用於存取儲存桶的儲存桶協定。定義的值為：

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

"bucketParameters"

True

此 JSON 物件提供存取儲存貯體所需的特定於儲存貯體提供者的資訊。此儲存貯體中的具體值因提供者而異。

中繼資料

"type_astra_metadata_update"

錯誤

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

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
範例請求 
{
  "type": "application/astra-bucket",
  "version": "1.2",
  "name": "Test Bucket",
  "credentialID": "d5b3854c-38de-42c6-9269-b5c052aba76f",
  "provider": "gcp",
  "bucketParameters": {
    "gcp": {
      "bucketName": "bucketName"
    }
  }
}

回應

Status: 201, Returns the newly created bucket resource in the JSON response body.
Name 類型 必要 說明

類型

字串

True

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

  • "application/astra-bucket"

版本

字串

True

資源版本。定義的值為：

  • "1.0"

  • "1.1"

  • "1.2"

ID

字串

True

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

  • 符合 UUIDv4 架構

姓名

字串

True

包含使用者為儲存貯體指定的名稱的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：256

credentialID

字串

True

包含用於存取儲存貯體的憑證識別碼的 JSON 字串。定義的值為：

  • 符合 Astra 識別符架構

狀態

字串

True

包含指示儲存貯體運作狀態的值的 JSON 字串。定義的值為：

  • 「pending」- 儲存貯體已排程進行探索

  • 「available」- 儲存貯體可供使用

  • 「failed」- 儲存區處於永久故障狀態

  • 「已移除」- 此儲存桶目前無法存取

  • 「未知」- 無法判斷儲存貯體狀態

stateDetails

陣列["type_astra_stateDetail"]

True

JSON 物件的 JSON 陣列，其中列出了有關「狀態」為何轉換為「已移除」或「失敗」的其他詳細資訊。如果沒有可用的詳細資料，此陣列將為空白。

  • 最少項目數：0

供應商

字串

True

JSON 字串，指示可用於存取儲存桶的儲存桶協定。定義的值為：

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

"bucketParameters"

True

此 JSON 物件提供存取儲存貯體所需的特定於儲存貯體提供者的資訊。此儲存貯體中的具體值因提供者而異。

中繼資料

"type_astra_metadata_update"

True

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

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
範例回應 
{
  "type": "application/astra-bucket",
  "version": "1.2",
  "id": "9b296ce0-c545-5022-acfa-1980c5aaea97",
  "name": "Test Bucket",
  "credentialID": "8f039324-7795-40bf-a5ca-4442580f7ab0",
  "state": "available",
  "stateDetails": [],
  "provider": "gcp",
  "bucketParameters": {
    "gcp": {
      "bucketName": "bucketName"
    }
  },
  "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

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

回應

Status: 409, Conflict
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

回應

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"
}

定義

請參閱定義

s3

提供 Simple Storage Service（S3）協定參數的 JSON 物件。（此物件適用於所有 S3 類型提供者）。

Name 類型 必要 說明

serverURL

字串

True

包含儲存貯體基礎路徑 URL 的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：1023

bucketName

字串

True

包含 S3 儲存貯體名稱的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

gcp

提供 Google Cloud 通訊協定參數的 JSON 物件。

Name 類型 必要 說明

bucketName

字串

True

包含底層 Google Cloud 儲存貯體名稱的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

azure

提供 Azure 通訊協定參數的 JSON 物件。

Name 類型 必要 說明

storageAccount

字串

True

包含 Azure 儲存體帳戶名稱的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

bucketName

字串

True

包含後端 Azure Blob 名稱的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

bucketParameters

此 JSON 物件提供存取儲存貯體所需的特定於儲存貯體提供者的資訊。此儲存貯體中的具體值因提供者而異。

Name 類型 必要 說明

s3

"s3"

錯誤

提供 Simple Storage Service（S3）協定參數的 JSON 物件。（此物件適用於所有 S3 類型提供者）。

gcp

"gcp"

錯誤

提供 Google Cloud 通訊協定參數的 JSON 物件。

azure

"azure"

錯誤

提供 Azure 通訊協定參數的 JSON 物件。

type_astra_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

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

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

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

type_astra_stateDetail

Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因

invalidFields

Name 類型 必要 說明

姓名

字串

True

無效請求內文欄位的名稱

原因

字串

True

請求本文欄位無效的原因