スナップショットスケジューリング設定履歴の照会

VPC環境で利用できます。

Search Engineクラスタのスナップショットスケジューリング設定履歴を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`serviceGroupInstanceNo`	Integer	Required	クラスタインスタンス番号クラスタリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~N (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/getSnapshotSchedulingHistory/1037*****?pageNo=1&pageSize=10' \
--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.currentPage`	Integer	-	現在のページ番号
`result.isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`result.isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`result.pageSize`	Integer	-	ページ表示数
`result.totalCount`	Integer	-	レスポンス結果数
`result.totalPage`	Integer	-	ページの総数
`result.snapshotSchedulingHistoryList`	Array	-	スナップショットスケジューリング設定履歴リスト
`requestId`	String	-	リクエスト ID UUID形式

`result.snapshotSchedulingHistoryList`

result.snapshotSchedulingHistoryListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`bucketName`	String	-	対象バケットの名前
`snapshotName`	String	-	スナップショット名
`snapshotSchedulingStatus`	String	-	スケジューリングの設定状態 `enable` \| `disable` `enable`: 設定 `disable`: 解除
`snapshotSchedulingSetUpDay`	String	-	スケジューリング作業曜日 `Everyday` \| `Sunday` \| `Monday` \| `Tuesday` \| `Wednesday` \| `Thursday` \| `Friday` \| `Saturday` `Everyday`: 毎日 `Sunday`: 日曜日 `Monday`: 月曜日 `Tuesday`: 火曜日 `Wednesday`: 水曜日 `Thursday`: 木曜日 `Friday`: 金曜日 `Saturday`: 土曜日
`snapshotSchedulingSetUpTime`	String	-	スケジューリング作業時刻
`snapshotSchedulingConfigSetUpDate`	String	-	スケジューリングの設定日時 yyyy-MM-dd HH:mm:ss形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "snapshotSchedulingHistoryList": [
            {
                "bucketName": "bk.ses.snapshot",
                "snapshotName": "snapshot",
                "snapshotSchedulingStatus": "enable",
                "snapshotSchedulingSetUpDay": "Everyday",
                "snapshotSchedulingSetUpTime": "23:30",
                "snapshotSchedulingConfigSetUpDate": "2025-03-25 15:55:04"
            },
            {
                "bucketName": "bk.ses.snapshot",
                "snapshotName": "snapshot",
                "snapshotSchedulingStatus": "disable",
                "snapshotSchedulingSetUpDay": "Everyday",
                "snapshotSchedulingSetUpTime": "11:00",
                "snapshotSchedulingConfigSetUpDate": "2025-03-21 10:23:59"
            }
        ]
    },
    "requestId": "cf899fba-****-****-****-e222c3fdd3ed"
}