Get all snapshots
get
/api/20210901/snapshots
Return a list of all known snapshots for a single Analytics instance. That is, snapshots in Oracle Cloud Infrastructure storage created or registered using the REST API.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Snapshot
Object which represents a snapshot.
Nested Schema : Snapshot
Type:
object
Object which represents a snapshot.
Show Source
-
bar(required): object
Bar
Snapshot BAR file.
-
createdByUser(required): string
User who created the snapshot.
-
id(required): string
Id of the snapshot.
-
name(required): string
Name of the snapshot.
-
storage(required):
Discriminator: type
Discriminator:
{ "propertyName":"type", "mapping":{ "OCI_NATIVE":"#/components/schemas/OCINativeStorage" } }
-
timeCreated(required): string
(date-time)
Time the snapshot was created.
Nested Schema : Bar
Type:
object
Snapshot BAR file.
Show Source
-
uri: string
URI of the BAR file in storage.
Nested Schema : Discriminator: type
Type:
object
Discriminator: type
Discriminator Values
Match One Schema
Show Source
-
OCINativeStorage
Oracle Cloud Infrastructure (OCI) storage details.
Nested Schema : OCINativeStorage
Oracle Cloud Infrastructure (OCI) storage details.
Match All
Show Source
-
object
Storage
Storage details.
-
object
OCINativeStorage-allOf[1]
Nested Schema : Storage
Type:
object
Storage details.
Show Source
-
auth(required):
Discriminator: type
Discriminator:
{ "propertyName":"type", "mapping":{ "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth" } }
-
type(required): string
Allowed Values:
[ "OCI_NATIVE" ]
Type of storage.
Nested Schema : OCINativeStorage-allOf[1]
Type:
Show Source
object
-
bucket: string
Name of a storage bucket in OCI object storage.
Nested Schema : Discriminator: type
Type:
object
Discriminator: type
Discriminator Values
Match One Schema
Show Source
-
OCIUserIdAuth
Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).
Nested Schema : OCIUserIdAuth
Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).
Match All
Show Source
-
object
Auth
Authentication details.
-
object
OCIUserIdAuth-allOf[1]
Nested Schema : Auth
Type:
object
Authentication details.
Show Source
-
type(required): string
Allowed Values:
[ "OSS_AUTH_OCI_USER_ID" ]
Type of authentication.
Nested Schema : OCIUserIdAuth-allOf[1]
Type:
Show Source
object
-
ociKeyFingerprint: string
Fingerprint of the public key.
-
ociPrivateKeyWrapped: string
Base64 encoded private key.
-
ociRegion: string
Name of the OCI region.
-
ociTenancyId: string
OCID of the tenancy.
-
ociUserId: string
OCID of the user.
400 Response
Bad Request (invalid query parameters, malformed headers, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
In this example, you obtain details of all available snapshots.
cURL Example:
curl -i \ --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/snapshots'
Example of Request Body
Not applicable.
Example of Response Body
Status 200: { "items": [ { "id": "ac6fdab7-9c16-4d22-a56f-cb7b5d15505a", "name": "myfirstsnapshot", "createdByUser": "Admin", "timeCreated": "2021-10-01T14:20:17.288Z", "storage": { "type": "OCI_NATIVE", "bucket": "mysnapshot-bucket", "auth": { "type": "OSS_AUTH_OCI_USER_ID", "ociRegion": "us-phoenix-1", "ociTenancyId": "ocid1.tenancy.oc1..xxxxx...", "ociUserId": "ocid1.user.oc1..xxxxxxxxxxxx..." } }, "bar": { "uri": "file:///myfolder/myfirstsnapshot.bar" } } ] }