すべてのバケットを一覧表示
GET /accounts/{account_id}/topology/v1/buckets
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"bucket_1.2_get_response_body"、配列[]] |
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
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 |
False |
s3を使用したチャンク アップロード署名要求がサポートされるようになりました。
Simple Storage Service(S3)プロトコルパラメータを提供するJSONオブジェクト。(すべてのS3タイプのプロバイダーにこのオブジェクトを使用します)。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
serverURL |
string |
True |
バケットのベースパスへのURLを含むJSON文字列。定義された値は次のとおりです:
|
bucketName |
string |
True |
S3バケット名を含むJSON文字列。定義された値は次のとおりです:
|
gcp
Google Cloudプロトコルパラメータを提供するJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
bucketName |
string |
True |
バックエンドとなるGoogle Cloudバケット名を含むJSON文字列。定義された値は次のとおりです:
|
azure
Azureプロトコルパラメータを提供するJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
storageAccount |
string |
True |
Azure ストレージアカウント名を含む JSON 文字列。定義された値は次のとおりです:
|
bucketName |
string |
True |
バックエンドとなるAzureブロブの名前を含むJSON文字列。定義された値は次のとおりです:
|
bucketParameters
バケットへのアクセスに必要な、バケットプロバイダー固有の情報を提供するJSONオブジェクト。このバケット内の具体的な値は、プロバイダーによって異なります。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
s3を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
False |
Simple Storage Service(S3)プロトコルパラメータを提供するJSONオブジェクト。(すべてのS3タイプのプロバイダーにこのオブジェクトを使用します)。 |
|
gcp |
False |
Google Cloudプロトコルパラメータを提供するJSONオブジェクト。 |
|
azure |
False |
Azureプロトコルパラメータを提供するJSONオブジェクト。 |
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata_update
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
bucket_1.2_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
名前 |
string |
True |
バケットにユーザーが割り当てた名前を含むJSON文字列。定義された値は次のとおりです:
|
credentialID |
string |
True |
バケットへのアクセスに使用される認証情報の識別子を含むJSON文字列。定義された値は次のとおりです:
|
状態 |
string |
True |
バケットの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
stateDetails |
True |
「state」が「removed」または「failed」に移行した理由に関する詳細情報をリストしたJSONオブジェクトのJSON配列。詳細情報が利用できない場合、この配列は空になります。
|
|
プロバイダ |
string |
True |
バケットへのアクセスに使用できるバケットプロトコルを示すJSON文字列。定義された値は次のとおりです:
|
bucketParameters |
True |
バケットへのアクセスに必要な、バケットプロバイダー固有の情報を提供するJSONオブジェクト。このバケット内の具体的な値は、プロバイダーによって異なります。 |
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
type_astra_metadata_list
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
続行 |
string |
False |
|
カウント |
番号 |
False |
|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |