---
title: "スナップショットスケジューリングの設定"
slug: "analytics-vpcsearchengine-snapshot-setsnapshotscheduling"
tags: ["Search Engine Service"]
updated: 2026-09-17T09:57:29Z
published: 2026-09-17T09:57:29Z
canonical: "api.ncloud-docs.com/analytics-vpcsearchengine-snapshot-setsnapshotscheduling"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# スナップショットスケジューリングの設定

VPC環境で利用できます。

Search Engineクラスタのスナップショットが自動作成されるようにスケジューリングを設定します。

## リクエスト

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

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

### リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、[Search Engine Serviceのリクエストヘッダ](/docs/ja/analytics-vpcsearchengine#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `serviceGroupInstanceNo` | Integer | Required | クラスタインスタンス番号 - [クラスタリストの照会](/docs/ja/analytics-vpcsearchengine-cluster-getclusterinfolist)を参照 |

### リクエストボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `snapshotName` | String | Required | スナップショット名 - 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力 - 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用 - 記号の「-」は連続使用不可 |
| `bucketName` | String | Required | Object Storageバケット名 - [バケットリストの照会](/docs/ja/analytics-vpcsearchengine-snapshot-getbucketlist)を参照 |
| `scheduledDay` | String | Required | スナップショットの作成曜日 - `Everyday` \| `Sunday` \| `Monday` \| `Tuesday` \| `Wednesday` \| `Thursday` \| `Friday` \| `Saturday` - `Everyday`: 毎日 - `Sunday`: 日曜日 - `Monday`: 月曜日 - `Tuesday`: 火曜日 - `Wednesday`: 水曜日 - `Thursday`: 木曜日 - `Friday`: 金曜日 - `Saturday`: 土曜日 |
| `scheduledHour` | Integer | Required | スナップショットの作成時刻(時) - 0~23 |
| `scheduledMinute` | Integer | Required | スナップショットの作成時刻(分) - `0` \| `15` \| `30` \| `45` |

### リクエスト例

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

```
curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/setSnapshotScheduling/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": "snpsht",
    "bucketName": "bk.ses.snapshot",
    "scheduledDay": "Everyday",
    "scheduledHour": 12,
    "scheduledMinute": 30
}'
```

## レスポンス

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

### レスポンスボディ

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

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

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

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Search Engine Serviceのレスポンスステータスコード](/docs/ja/analytics-vpcsearchengine#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

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