Available in VPC
Get search engine cluster snapshot creation history.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (Korea Region) |
GET | /api/sgn-v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (Singapore Region) |
GET | /api/jpn-v2/snapshot/getSnapshotHistory/{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 query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
pageNo |
Integer | Optional | Page number
|
pageSize |
Integer | Optional | Page output count
|
Request example
The request example is as follows:
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}'
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 |
Object | - | Response result |
result.currentPage |
Integer | - | Current page number |
result.isFirst |
Boolean | - | Whether it is the first page
|
result.isLast |
Boolean | - | Whether it is the last page
|
result.pageSize |
Integer | - | Page output count |
result.totalCount |
Integer | - | Number of response results |
result.totalPage |
Integer | - | Total number of pages |
result.snapshotHistoryResponseList |
Array | - | Snapshot creation history list |
requestId |
String | - | ID for the request
|
result.snapshotHistoryResponseList
The following describes result.snapshotHistoryResponseList
.
Field | Type | Required | Description |
---|---|---|---|
idx |
Integer | - | History serial number |
clusterName |
String | - | Cluster name |
snapshotName |
String | - | Snapshot name |
memberNo |
String | - | User's NAVER Cloud Platform member ID |
serviceGroupInstanceNo |
Integer | - | Cluster instance number |
actionDate |
String | - | Job date and time
|
duration |
String | - | Execution time |
requestType |
String | - | Job type
|
message |
String | - | Task details |
bucketName |
String | - | Target bucket name |
hasErrorLog |
Boolean | - | Whether error occurred and log generated
|
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": {
"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 snapshot creation completed",
"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 snapshot creation started",
"bucketName": "bk.ses.snapshot",
"hasErrorLog": false
}
]
},
"requestId": "835bee49-****-****-****-57a3ec4e85eb"
}