スナップショット作成履歴の照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタのスナップショット作成履歴を照会します。

リクエスト

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

メソッド URI
GET /api/v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v2/snapshot/getSnapshotHistory/{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/getSnapshotHistory/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.snapshotHistoryResponseList Array - スナップショット作成履歴リスト
requestId String - リクエスト ID
  • UUID形式

result.snapshotHistoryResponseList

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

フィールド タイプ 必須の有無 説明
idx Integer - 履歴のシリアル番号
clusterName String - クラスタ名
snapshotName String - スナップショット名
memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
serviceGroupInstanceNo Integer - クラスタインスタンス番号
actionDate String - 作業日時
  • yyyy-MM-dd HH:mm:ss形式
duration String - 実行時間
requestType String - 作業タイプ
  • R | C
    • R: リクエスト
    • C: 完了
message String - 作業履歴
bucketName String - 対象バケットの名前
hasErrorLog Boolean - エラー発生・ログ作成の有無
  • true | false
    • true: エラーが発生し、ログが存在
    • false: エラーなし

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "snapshotHistoryResponseList": [
            {
                "idx": 7742,
                "clusterName": "cluster000",
                "snapshotName": "snapshot-20250324",
                "memberNo": "279****",
                "serviceGroupInstanceNo": 1037*****,
                "actionDate": "2025-03-24 16:49:33",
                "duration": "403ms",
                "requestType": "C",
                "message": "snapshot-20250324 スナップショット作成完了",
                "bucketName": "bk.ses.snapshot",
                "hasErrorLog": false
            },
            {
                "idx": 7741,
                "clusterName": "cluster000",
                "snapshotName": "snapshot-20250324",
                "memberNo": "279****",
                "serviceGroupInstanceNo": 1037*****,
                "actionDate": "2025-03-24 16:49:32",
                "duration": null,
                "requestType": "R",
                "message": "snapshot-20250324 スナップショット作成開始",
                "bucketName": "bk.ses.snapshot",
                "hasErrorLog": false
            }
        ]
    },
    "requestId": "835bee49-****-****-****-57a3ec4e85eb"
}