get-bucket-list

VPC環境で利用できます。

Data Box Frameの持ち込みまはた持ち出し時に使用する Object Storageサービスのバケットリストを照会します。

参考

get-bucket-list APIを使用するには、先に Object Storageサービスを申し込んでバケットを作成する必要があります。ご利用の申し込みとバケットの作成方法の詳細は、次をご参照ください。

NAVERクラウドプラットフォームコンソールでご利用を申し込んで作成: Object Storageご利用ガイドを参照
APIを使用して作成: PutBucketを参照

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/bucket/get-bucket-list

リクエストヘッダ

Data Box Frame APIで共通して使用されるヘッダの詳細は、Data Box Frameのリクエストヘッダをご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	レスポンス結果数
`content`	Array	-	バケットリスト

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`disabled`	Boolean	-	バケットは使用できるかどうか `true` \| `false` `true`: 不可 `false`: 可能
`bucketName`	String	-	バケット名

レスポンスステータスコード

Data Box Frame APIで共通して使用されるレスポンスステータスコードの詳細は、Data Box Frame APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "totalCount": 1,
    "content": [
        {
            "disabled": false,
            "bucketName": "testddfdas"
        }
    ]
}