Available in VPC
Get search engine cluster snapshot creation scheduling configuration history.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v2/snapshot/getSnapshotSchedulingHistory/{serviceGroupInstanceNo} (Korea Region) |
GET | /api/sgn-v2/snapshot/getSnapshotSchedulingHistory/{serviceGroupInstanceNo} (Singapore Region) |
GET | /api/jpn-v2/snapshot/getSnapshotSchedulingHistory/{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/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}'
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.snapshotSchedulingHistoryList |
Array | - | Snapshot scheduling configuration history list |
requestId |
String | - | ID for the request
|
result.snapshotSchedulingHistoryList
The following describes result.snapshotSchedulingHistoryList
.
Field | Type | Required | Description |
---|---|---|---|
bucketName |
String | - | Target bucket name |
snapshotName |
String | - | Snapshot name |
snapshotSchedulingStatus |
String | - | Scheduling configuration status
|
snapshotSchedulingSetUpDay |
String | - | Scheduling job day of the week
|
snapshotSchedulingSetUpTime |
String | - | Scheduling job time |
snapshotSchedulingConfigSetUpDate |
String | - | Scheduling configuration date and time
|
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,
"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"
}