バケットリストの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタのスナップショットが保存可能な Object Storageバケットリストを照会します。

参考

Object Storageにアクセスするには、API認証キーが必要です。API認証キーの設定方法の詳細は次をご参照ください。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/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形式
bucketProtectionState String - バケットセキュリティの設定有無
  • ENABLED | DISABLED
    • ENABLED: セキュリティ設定(スナップショットを保存できない)
    • DISABLED: セキュリティ未設定(スナップショットを保存できる)
permission String - バケットアクセス権限の有無
  • Allow | Deny
    • Allow: アクセス許可
    • Deny: アクセス不可

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "bucketList": [
            {
                "name": "bk.lib",
                "bytesUsed": 40940,
                "objectCount": 15,
                "creationTime": 1742341291251,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            },
            {
                "name": "bk.ses.snapshot",
                "bytesUsed": 512924,
                "objectCount": 108,
                "creationTime": 1742520149085,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            },
            {
                "name": "bucket3",
                "bytesUsed": 68557,
                "objectCount": 9,
                "creationTime": 1742189392156,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            }
        ]
    },
    "requestId": "b67c900f-****-****-****-6ba8f81cafe6"
}