mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-02-09 14:24:47 +00:00
* add files for snapshot creation Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Create new topics and fix existing. Modify index.md Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Address Fanit's edits. Apply edits to other files as needed for consistenty. Create new files: get-snapshot.status.md and restore-snapshot.md. Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Add .md file extension to get-snapshot-repository file Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Add verify-snapshot-repository.md, renumber nav_order in other snapshot topics to place the new topic correctly. Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Apply Fanit's edits to restore-snapsnot.md and verify-snapshot-repository.md Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Address Fanit's edits. Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> * Change 'Response fields' heading level to 3. Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local> Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
3.4 KiB
3.4 KiB
layout | title | parent | grand_parent | nav_order |
---|---|---|---|---|
default | Get Snapshot | Snapshot APIs | REST API reference | 6 |
Get snapshot.
Retrieves information about a snapshot.
Path parameters
Parameter | Data Type | Description |
---|---|---|
repository | String | The repository that contains the snapshot to retrieve. |
snapshot | String | Snapshot to retrieve. |
Query parameters
Parameter | Data Type | Description |
---|---|---|
verbose | Boolean | Whether to show all, or just basic snapshot information. If true , returns all information. If false , omits information like start/end times, failures, and shards. Optional, defaults to true . |
ignore_unavailable | Boolean | How to handle snapshots that are unavailable (corrupted or otherwise temporarily can't be returned). If true and the snapshot is unavailable, the request does not return the snapshot. If false and the snapshot is unavailable, the request returns an error. Optional, defaults to false . |
Sample request
The following request retrieves information for the my-first-snapshot
located in the my-opensearch-repo
repository:
GET _snapshot/my-opensearch-repo/my-first-snapshot
Sample response
Upon success, the response returns snapshot information:
{
"snapshots" : [
{
"snapshot" : "my-first-snapshot",
"uuid" : "3P7Qa-M8RU6l16Od5n7Lxg",
"version_id" : 136217927,
"version" : "2.0.1",
"indices" : [
".opensearch-observability",
".opendistro-reports-instances",
".opensearch-notifications-config",
"shakespeare",
".opendistro-reports-definitions",
"opensearch_dashboards_sample_data_flights",
".kibana_1"
],
"data_streams" : [ ],
"include_global_state" : true,
"state" : "SUCCESS",
"start_time" : "2022-08-11T20:30:00.399Z",
"start_time_in_millis" : 1660249800399,
"end_time" : "2022-08-11T20:30:14.851Z",
"end_time_in_millis" : 1660249814851,
"duration_in_millis" : 14452,
"failures" : [ ],
"shards" : {
"total" : 7,
"failed" : 0,
"successful" : 7
}
}
]
}
Response fields
Field | Data Type | Description |
---|---|---|
snapshot | string | Snapshot name. |
uuid | string | Snapshot's universally unique identifier (UUID). |
version_id | int | Build ID of the Open Search version that created the snapshot. |
version | float | Open Search version that created the snapshot. |
indices | array | Indices in the snapshot. |
data_streams | array | Data streams in the snapshot. |
include_global_state | boolean | Whether the current cluster state is included in the snapshot. |
start_time | string | Date/time when the snapshot creation process began. |
start_time_in_millis | long | Time (in milliseconds) when the snapshot creation process began. |
end_time | string | Date/time when the snapshot creation process ended. |
end_time_in_millis | long | Time (in milliseconds) when the snapshot creation process ended. |
duration_in_millis | long | Total time (in milliseconds) that the snapshot creation process lasted. |
failures | array | Failures, if any, that occured during snapshot creation. |
shards | object | Total number of shards created along with number of successful and failed shards. |
state | string | Snapshot status. Possible values: IN_PROGRESS , SUCCESS , FAILED , PARTIAL . |