Get site(s) OpenSearch snapshot

GET 
/sites/:siteId/opensearch/snapshots/:snapshotName

Returns the OpenSearch Snapshot

Request

Path Parameters

siteId stringrequired

Site Identifier

snapshotName stringrequired

Snapshot Name

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

snapshots

object[]

Array [

snapshot string

Snapshot name

uuid string

Snapshot’s universally unique identifier (UUID)

version string

Open Search version that created the snapshot

indices string[]

Indices in the snapshot

shards

object

total number

Total number of shards

failed number

Failed number of shards

successful number

Successful number of shards

failures

object[]

Array [

index string

The index name.

index_uuid string

UUID of the index.

shard_id int32

Shard identifier.

reason string

Full exception/message explaining why the failure occurred.

node_id string

ID of the node handling that shard.

status string

Status of the failure (e.g., INTERNAL_SERVER_ERROR).

]

state string

Snapshot status. Possible values: IN_PROGRESS, SUCCESS, FAILED, PARTIAL

start_time string

Date/time when the snapshot creation process began

start_time_in_millis number

Time (in milliseconds) when the snapshot creation process began

end_time string

Date/time when the snapshot creation process ended

end_time_in_millis number

Time (in milliseconds) when the snapshot creation process ended

duration_in_millis number

Total time (in milliseconds) that the snapshot creation process lasted

]

Example (from schema)

{
  "snapshots": [
    {
      "snapshot": "string",
      "uuid": "string",
      "version": "string",
      "indices": [
        "string"
      ],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      },
      "failures": [
        {
          "index": "string",
          "index_uuid": "string",
          "shard_id": 0,
          "reason": "string",
          "node_id": "string",
          "status": "string"
        }
      ],
      "state": "string",
      "start_time": "string",
      "start_time_in_millis": 0,
      "end_time": "string",
      "end_time_in_millis": 0,
      "duration_in_millis": 0
    }
  ]
}

Loading...