バケットリストの照会

Prev Next

VPC環境で利用できます。

データ持ち込みが可能な Object Storageバケットリストを照会します。

参考

リクエスト時に入力した Access Keyに基づいてバケットの使用権限を確認します。

リクエスト

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

メソッド URI
GET /api/v2/import/getBucketList/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v2/import/getBucketList/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v2/import/getBucketList/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/import/getBucketList/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.bucketList Array - バケットリスト
requestId String - リクエスト ID
  • UUID形式

result.bucketList

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

フィールド タイプ 必須の有無 説明
name String - バケット名
bytesUsed Integer - バケットのサイズ
objectCount Integer - オブジェクト数
creationTime Integer - バケットの作成日時
  • Unix Timestamp形式
resourceId String - バケットリソース ID

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "bucketList": [
            {
                "name": "bk.c",
                "bytesUsed": 12763741,
                "objectCount": 6,
                "creationTime": 1742888127098,
                "resourceId": "Bucket/bk.c/174288*******"
            },
            ...
            {
                "name": "bk.ses.snapshot",
                "bytesUsed": 540095,
                "objectCount": 123,
                "creationTime": 1742520149085,
                "resourceId": "Bucket/bk.ses.snapshot/174252*******"
            },
            ...
        ]
    },
    "requestId": "e086393d-****-****-****-2aed3fb5b447"
}