Skip to main content
23.07
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

バケットを取得する

PDF

GET /accounts/{account_id}/topology/v1/buckets/{bucket_id}

JSON レスポンス ボディに格納された Bucket API リソースを返します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

bucket_id

string

path（パス）

True

リストするバケットコレクションのID

応答

Status: 200, Returns the stored Bucket API resource in the JSON response body.
Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-bucket"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

  • "1.2"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

バケットにユーザーが割り当てた名前を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：256

credentialID

string

True

バケットへのアクセスに使用される認証情報の識別子を含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

状態

string

True

バケットの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「pending」 - バケットは検出予定

  • 「available」 - バケットは使用可能です

  • 「failed」 - バケットが永続的な失敗状態にあります

  • 「removed」 - バケットには現在アクセスできません

  • 「不明」 - バケットの状態を判断できません

stateDetails

配列["type_astra_stateDetail"]

True

「state」が「removed」または「failed」に移行した理由に関する詳細情報をリストしたJSONオブジェクトのJSON配列。詳細情報が利用できない場合、この配列は空になります。

  • 最小アイテム数：0

プロバイダ

string

True

バケットへのアクセスに使用できるバケットプロトコルを示すJSON文字列。定義された値は次のとおりです：

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

"bucketParameters"

True

バケットへのアクセスに必要な、バケットプロバイダー固有の情報を提供するJSONオブジェクト。このバケット内の具体的な値は、プロバイダーによって異なります。

メタデータ

"type_astra_metadata_update"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
回答例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 403, Forbidden
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
エラー応答の例 
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

additionalDetails

"additionalDetails"

False

s3を使用したチャンク アップロード署名要求がサポートされるようになりました。

Simple Storage Service（S3）プロトコルパラメータを提供するJSONオブジェクト。（すべてのS3タイプのプロバイダーにこのオブジェクトを使用します）。

Name を入力します 必須 説明

serverURL

string

True

バケットのベースパスへのURLを含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：1023

bucketName

string

True

S3バケット名を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：63

gcp

Google Cloudプロトコルパラメータを提供するJSONオブジェクト。

Name を入力します 必須 説明

bucketName

string

True

バックエンドとなるGoogle Cloudバケット名を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：63

azure

Azureプロトコルパラメータを提供するJSONオブジェクト。

Name を入力します 必須 説明

storageAccount

string

True

Azure ストレージアカウント名を含む JSON 文字列。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：63

bucketName

string

True

バックエンドとなるAzureブロブの名前を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：63

bucketParameters

バケットへのアクセスに必要な、バケットプロバイダー固有の情報を提供するJSONオブジェクト。このバケット内の具体的な値は、プロバイダーによって異なります。

Name を入力します 必須 説明

s3を使用したチャンク アップロード署名要求がサポートされるようになりました。

"s3を使用したチャンク アップロード署名要求がサポートされるようになりました。"

False

Simple Storage Service（S3）プロトコルパラメータを提供するJSONオブジェクト。（すべてのS3タイプのプロバイダーにこのオブジェクトを使用します）。

gcp

"gcp"

False

Google Cloudプロトコルパラメータを提供するJSONオブジェクト。

azure

"azure"

False

Azureプロトコルパラメータを提供するJSONオブジェクト。

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由