REST API for Oracle Analytics Cloud

Create a snapshot

post

/api/20210901/snapshots

Create a new snapshot resource for an Analytics instance. Either create a new snapshot BAR file in Oracle Cloud Infrastructure (OCI) storage and register the snapshot with the Analytics instance ("type": "CREATE"). Or register an existing snapshot BAR file in OCI storage with the Analytics instance ("type": "REGISTER").

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : Discriminator: type

Type: object

Discriminator: type

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateRegisterSnapshot"
        },
        {
            "$ref":"#/components/schemas/RegisterSnapshot"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "CREATE":"#/components/schemas/CreateRegisterSnapshot",
            "REGISTER":"#/components/schemas/RegisterSnapshot"
        }
    }
}

Match One Schema

Show Source

CreateRegisterSnapshot

Object used to create and register a new snapshot BAR file.
RegisterSnapshot

Object used to register an existing snapshot BAR file.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateRegisterSnapshot"
        },
        {
            "$ref":"#/components/schemas/RegisterSnapshot"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "CREATE":"#/components/schemas/CreateRegisterSnapshot",
            "REGISTER":"#/components/schemas/RegisterSnapshot"
        }
    }
}

Nested Schema : CreateRegisterSnapshot

Object used to create and register a new snapshot BAR file.

Match All

Show Source

object NewSnapshot

Object used to create a snapshot.
object CreateRegisterSnapshot-allOf[1]

{
    "description":"Object used to create and register a new snapshot BAR file.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NewSnapshot"
        },
        {
            "type":"object",
            "properties":{
                "bar":{
                    "$ref":"#/components/schemas/PasswordBar"
                }
            }
        }
    ],
    "required":[
        "bar"
    ]
}

Nested Schema : RegisterSnapshot

Object used to register an existing snapshot BAR file.

Match All

Show Source

object NewSnapshot

Object used to create a snapshot.
object RegisterSnapshot-allOf[1]

{
    "description":"Object used to register an existing snapshot BAR file.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NewSnapshot"
        },
        {
            "type":"object",
            "properties":{
                "bar":{
                    "$ref":"#/components/schemas/Bar"
                }
            }
        }
    ],
    "required":[
        "bar"
    ]
}

Nested Schema : NewSnapshot

Type: object

Object used to create a snapshot.

Show Source

name(required): string
storage(required): Discriminator: type

Discriminator: { "propertyName":"type", "mapping":{ "OCI_NATIVE":"#/components/schemas/OCINativeStorage" } }
type(required): object SnapshotCreateType

Type of snapshot creation. You can either create a new snapshot BAR file and register the new snapshot with your Analytics instance ("type": "CREATE") or register an existing snapshot BAR file ("type": "REGISTER").

{
    "description":"Object used to create a snapshot.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/SnapshotCreateType"
        },
        "name":{
            "type":"string"
        },
        "storage":{
            "$ref":"#/components/schemas/StorageOneOf"
        }
    },
    "required":[
        "type",
        "name",
        "storage"
    ]
}

Nested Schema : CreateRegisterSnapshot-allOf[1]

Type: object

Show Source

bar: PasswordBar

Snapshot BAR file protected with a password.

{
    "type":"object",
    "properties":{
        "bar":{
            "$ref":"#/components/schemas/PasswordBar"
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

OCI_NATIVE

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

Match One Schema

Show Source

OCINativeStorage

Oracle Cloud Infrastructure (OCI) storage details.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

Nested Schema : SnapshotCreateType

Type: object

Type of snapshot creation. You can either create a new snapshot BAR file and register the new snapshot with your Analytics instance ("type": "CREATE") or register an existing snapshot BAR file ("type": "REGISTER").

Show Source

type(required): string

Allowed Values: [ "CREATE", "REGISTER" ]

{
    "description":"Type of snapshot creation. You can either create a new snapshot BAR file and register the new snapshot with your Analytics instance (\"type\": \"CREATE\") or register an existing snapshot BAR file (\"type\": \"REGISTER\").",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CREATE",
                "REGISTER"
            ]
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : OCINativeStorage

Oracle Cloud Infrastructure (OCI) storage details.

Match All

Show Source

object Storage

Storage details.
object OCINativeStorage-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) storage details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Storage"
        },
        {
            "type":"object",
            "properties":{
                "bucket":{
                    "type":"string",
                    "description":"Name of a storage bucket in OCI object storage."
                }
            }
        }
    ]
}

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): object StorageType

Type of storage.

{
    "description":"Storage details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/StorageType"
        },
        "auth":{
            "$ref":"#/components/schemas/AuthOneOf"
        }
    },
    "required":[
        "type",
        "auth"
    ]
}

Nested Schema : OCINativeStorage-allOf[1]

Type: object

Show Source

bucket: string

Name of a storage bucket in OCI object storage.

{
    "type":"object",
    "properties":{
        "bucket":{
            "type":"string",
            "description":"Name of a storage bucket in OCI object storage."
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

OSS_AUTH_OCI_USER_ID

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth"
        }
    }
}

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).

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth"
        }
    }
}

Nested Schema : StorageType

Type: object

Type of storage.

Show Source

type(required): string

Allowed Values: [ "OCI_NATIVE" ]

{
    "description":"Type of storage.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "OCI_NATIVE"
            ]
        }
    },
    "required":[
        "type"
    ]
}

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]

{
    "description":"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).",
    "allOf":[
        {
            "$ref":"#/components/schemas/Auth"
        },
        {
            "type":"object",
            "properties":{
                "ociRegion":{
                    "type":"string",
                    "description":"Name of the OCI region."
                },
                "ociTenancyId":{
                    "type":"string",
                    "description":"OCID of the tenancy."
                },
                "ociUserId":{
                    "type":"string",
                    "description":"OCID of the user."
                },
                "ociKeyFingerprint":{
                    "type":"string",
                    "description":"Fingerprint of the public key."
                },
                "ociPrivateKeyWrapped":{
                    "type":"string",
                    "description":"Base64 encoded private key."
                }
            }
        }
    ],
    "required":[
        "ociRegion",
        "ociTenancyId",
        "ociUserId"
    ]
}

Nested Schema : Auth

Type: object

Authentication details.

Show Source

type(required): object AuthType

Type of authentication.

{
    "description":"Authentication details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/AuthType"
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : OCIUserIdAuth-allOf[1]

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "ociRegion":{
            "type":"string",
            "description":"Name of the OCI region."
        },
        "ociTenancyId":{
            "type":"string",
            "description":"OCID of the tenancy."
        },
        "ociUserId":{
            "type":"string",
            "description":"OCID of the user."
        },
        "ociKeyFingerprint":{
            "type":"string",
            "description":"Fingerprint of the public key."
        },
        "ociPrivateKeyWrapped":{
            "type":"string",
            "description":"Base64 encoded private key."
        }
    }
}

Nested Schema : AuthType

Type: object

Type of authentication.

Show Source

type(required): string

Allowed Values: [ "OSS_AUTH_OCI_USER_ID" ]

{
    "description":"Type of authentication.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "OSS_AUTH_OCI_USER_ID"
            ]
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : PasswordBar

Snapshot BAR file protected with a password.

Match All

Show Source

object Bar

Snapshot BAR file.
object PasswordBar-allOf[1]

{
    "description":"Snapshot BAR file protected with a password.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Bar"
        },
        {
            "type":"object",
            "properties":{
                "password":{
                    "type":"string",
                    "description":"Password of the BAR file."
                }
            }
        }
    ]
}

Nested Schema : Bar

Type: object

Snapshot BAR file.

Show Source

uri: string

URI of the BAR file in storage.

{
    "description":"Snapshot BAR file.",
    "type":"object",
    "properties":{
        "uri":{
            "type":"string",
            "description":"URI of the BAR file in storage."
        }
    }
}

Nested Schema : PasswordBar-allOf[1]

Type: object

Show Source

password: string

Password of the BAR file.

{
    "type":"object",
    "properties":{
        "password":{
            "type":"string",
            "description":"Password of the BAR file."
        }
    }
}

Nested Schema : RegisterSnapshot-allOf[1]

Type: object

Show Source

bar: object Bar

Snapshot BAR file.

{
    "type":"object",
    "properties":{
        "bar":{
            "$ref":"#/components/schemas/Bar"
        }
    }
}

Response

202 Response

Asynchronous operation started.

Headers

oa-work-request-id(required):

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Examples

You can either create a new snapshot ("type": "CREATE") or register an existing snapshot ("type": "REGISTER").

Example 1 (type=CREATE): Create a new snapshot of your Oracle Analytics instance, save the snapshot in cloud storage, and register the snapshot with your Oracle Analytics instance.
Example 2 (type=REGISTER): Register an existing snapshot in cloud storage with an Oracle Analytics instance.

In both cases, you need to specify connection information for the Oracle Cloud Infrastructure storage bucket where you want to save the new snapshot file or where the existing snapshot (BAR file) is stored.

Example 1 Create and register a snapshot

In this example, you create a snapshot (BAR file) of an Oracle Analytics instance, save the new BAR file in Oracle Cloud Infrastructure Object Storage, and register the snapshot with the Oracle Analytics instance.

cURL Example

First, create a JSON file that contains the properties required to create and register the snapshot (set the type property to CREATE).

If you haven't done so already, you must generate an Oracle Cloud Infrastructure API signing key. See How to Generate an API Signing Key. Before you add the key to the JSON file, you must Base64 encode the private key (ociPrivateKeyWrapped). For example, to generate a Base64 encoded string from your private key:

On Mac: cat myprivate-key.pem | base64 -o mywrapped-private-key.pem

On Linux: cat myprivate-key.pem | base64 -w 0 > mywrapped-private-key.pem

Note: Ensure that the private key file that you encode includes -----BEGIN and -----END tags.

When you specify a password for the snapshot, ensure it's between 8 and 50 characters long and contains at least one numeric character, one uppercase letter, and one lowercase letter.

For example, create a JSON file called new_snapshot.json that looks like this:

{
    "type": "CREATE",
    "name": "myfirstsnapshot",
    "storage": {
        "type": "OCI_NATIVE",
        "bucket": "mysnapshot-bucket",
        "auth": {
            "type": "OSS_AUTH_OCI_USER_ID",
            "ociRegion": "us-phoenix-1",
            "ociTenancyId": "ocid1.tenancy.oc1..aaaaa...",
            "ociUserId": "ocid1.user.oc1..aaaaaaaayuvg...",
            "ociKeyFingerprint": "ae:df:79:d2:...",
            "ociPrivateKeyWrapped": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tL..."
        }
    },
    "bar": {
        "uri": "file:///myfolder/myfirstsnapshot.bar",
        "password": "snapshotPassword123"
    }
}

Then run the cURL command calling the JSON file (for example, new_snapshot.json):

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request POST 'https://<hostname>/api/20210901/snapshots' \
  -d @new_snapshot.json

Example 2 Register an existing snapshot

In this example, you register a snapshot (BAR file) that you previously uploaded to Oracle Cloud Infrastructure Object Storage with an Oracle Analytics instance. If you want to restore an Oracle Analytics instance from a snapshot in cloud storage, you need to register the snapshot with the Oracle Analytics instance.

cURL Example:

First, create a JSON file that contains the properties required to specify the BAR file you want to register (set the type property to REGISTER).

Like the create snapshot example, you must Base64 encode the private key before you add it to the JSON file (ociPrivateKeyWrapped).

For example, create a JSON file called registermy_snapshot.json that looks like this:

{
    "type": "REGISTER",
    "name": "mysavedsnapshot",
    "storage": {
        "type": "OCI_NATIVE",
        "bucket": "mysnapshot-bucket",
        "auth": {
            "type": "OSS_AUTH_OCI_USER_ID",
            "ociRegion": "us-phoenix-1",
            "ociTenancyId": "ocid1.tenancy.oc1..aaaaa...",
            "ociUserId": "ocid1.user.oc1..aaaaaaaayuvg...",
            "ociKeyFingerprint": "ae:df:79:d2:...",
            "ociPrivateKeyWrapped": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tL..."
        }
    },
    "bar": {
        "uri": "file:///myfolder/mysavedsnapshot.bar"
    }
}

Then run the cURL command calling the JSON file (for example, registermy_snapshot.json):

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request POST 'https://<hostname>/api/20210901/snapshots' \
  -d @registermy_snapshot.json

Example of Response Header

Make a note of the oa-work-request-id in the response header. You can use this value to track the status of your operation.

oa-work-request-id: lfc-c2:152-cd:607

Example of Response Body

Alternatively, make a note of the workRequestId in the response body. You use this value to track the status of your operation.

{
    "workRequestId": "lfc-c2:152-cd:607"
}