スナップショットの作成

Prev Next

VPC環境で利用できます。

Search Engineクラスタのスナップショットを作成します。作成したスナップショットは Object Storageのバケットに保存されます。

参考

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
snapshotName String Required スナップショット名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
bucketName String Required Object Storageバケット名

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/createSnapshot/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "snapshotName": "snapshot-20250324",
    "bucketName": "bk.ses.snapshot"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "f1c17f0b-****-****-****-9c6d0dfd5ec2"
}