Object Storageバケットリストの照会

Classic/VPC環境で利用できます。

使用可能な Object Storageバケットリストを照会します。

参考

バケットリストを照会するには、まず Object Storageサービスでバケットを作成する必要があります。バケットの作成方法の詳細は次をご参照ください。

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

リクエスト

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

メソッド	URI
GET	/api/v1/objectstorage/bucket

リクエストヘッダ

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.bucketList`	Array	-	バケットリスト

`bucketList`

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

フィールド	タイプ	必須の有無	説明
`name`	String	-	Object Storageバケット名
`permission`	String	-	詳細情報の照会権限を持っているか `Allow` \| `Deny` `Allow`: 持っている `Deny`: 持っていない
`actionName`	String	-	詳細情報照会権限名

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

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

レスポンス例

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

{
    "result": {
        "bucketList": [
            {
                "name": "datastorage",
                "permission": "Allow",
                "actionName": "View/getBucketDetail"
            },
            {
                "name": "devtool",
                "permission": "Allow",
                "actionName": "View/getBucketDetail"
            }
        ]
    }
}