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のリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceGroupInstanceNo |
Integer | Required | クラスタインスタンス番号
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
snapshotName |
String | Required | スナップショット名
|
bucketName |
String | Required | Object Storageバケット名
|
scheduledDay |
String | Required | スナップショットの作成曜日
|
scheduledHour |
Integer | Required | スナップショットの作成時刻(時)
|
scheduledMinute |
Integer | Required | スナップショットの作成時刻(分)
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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 | - | レスポンス結果
|
requestId |
String | - | リクエスト ID
|
レスポンスステータスコード
Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "f1c17f0b-****-****-****-9c6d0dfd5ec2"
}