Create snapshot

Prev Next

Available in VPC

Create a search engine cluster snapshot. Created snapshots are stored in the Object Storage bucket.

Note

An API authentication key is required to access Object Storage. See the following for how to set up an API authentication key.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/snapshot/createSnapshot/{serviceGroupInstanceNo} (Korea Region)
POST /api/sgn-v2/snapshot/createSnapshot/{serviceGroupInstanceNo} (Singapore Region)
POST /api/jpn-v2/snapshot/createSnapshot/{serviceGroupInstanceNo} (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
serviceGroupInstanceNo Integer Required Cluster instance number

Request body

You can include the following data in the body of your request:

Field Type Required Description
snapshotName String Required Snapshot name
  • Enter 3 to 30 characters using a combination of lowercase English letters, numbers, and the special character "-".
  • The string must start with a lowercase English letter and end with a lowercase English letter or a number.
  • Special character "-" can't be used consecutively.
bucketName String Required Object Storage bucket name

Request example

The request example is as follows:

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"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Boolean - Response result
  • true | null
    • true: succeeded
    • null: failed
requestId String - ID for the request
  • UUID format

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

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