Oracle Analytics CloudのためのREST API

スナップショットの作成

post

/api/20210901/snapshots

アナリティクス・インスタンスの新規スナップショット・リソースを作成します。 Oracle Cloud Infrastructure (OCI)ストレージに新しいスナップショットBARファイルを作成し、そのスナップショットをアナリティクス・インスタンス(タイプ)に登録: "CREATE"). または、OCIストレージの既存のスナップショットBARファイルをアナリティクス・インスタンス(「type」)に登録: "REGISTER").

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ

application/json

ルート・スキーマ : 識別子 : type

Type: object

識別子: type

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

1つのスキーマに一致

ソースを表示

CreateRegisterSnapshot

新規スナップショットBARファイルの作成および登録に使用されるオブジェクト。
RegisterSnapshot

既存のスナップショットBARファイルの登録に使用されるオブジェクト。

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

ネストされたスキーマ : CreateRegisterSnapshot

新規スナップショットBARファイルの作成および登録に使用されるオブジェクト。

すべてに一致

新規スナップショットBARファイルの作成および登録に使用されるオブジェクト。

ソースを表示

object NewSnapshot

スナップショットの作成に使用されるオブジェクト。
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"
    ]
}

ネストされたスキーマ : RegisterSnapshot

既存のスナップショットBARファイルの登録に使用されるオブジェクト。

すべてに一致

既存のスナップショットBARファイルの登録に使用されるオブジェクト。

ソースを表示

object NewSnapshot

スナップショットの作成に使用されるオブジェクト。
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"
    ]
}

ネストされたスキーマ : NewSnapshot

Type: object

スナップショットの作成に使用されるオブジェクト。

ソースを表示

name(required): string
storage(required): 識別子: type

識別子 : { "propertyName":"type", "mapping":{ "OCI_NATIVE":"#/components/schemas/OCINativeStorage" } }
type(required): string

許容値: [ "CREATE", "REGISTER" ]

スナップショット作成のタイプ。新しいスナップショットBARファイルを作成して、新しいスナップショットをアナリティクス・インスタンス(「type」)に登録できます: 既存のスナップショットBARファイル(タイプ)をCREATEまたは登録: "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"
    ]
}

ネストされたスキーマ : CreateRegisterSnapshot-allOf[1]

Type: object

ソースを表示

バー: PasswordBar

パスワードで保護されたスナップショットBARファイル。

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

ネストされたスキーマ : Discriminator: type

Type: object

識別子: type

弁別子の値

OCI_NATIVE

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

1つのスキーマに一致

ソースを表示

OCINativeStorage

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

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

ネストされたスキーマ : OCINativeStorage

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

すべてに一致

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

ソースを表示

object 「ストレージ」

記憶域詳細
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."
                },
                "bucketOciRegion":{
                    "type":"string",
                    "description":"Region where the storage bucket exists. Only required when the bucket is located in a different region."
                },
                "bucketOciNamespace":{
                    "type":"string",
                    "description":"Namespace where the storage bucket exists. Only required when the bucket is located in a different tenancy."
                }
            }
        }
    ]
}

ネストされたスキーマ : ストレージ

Type: object

記憶域詳細

ソースを表示

auth(required): 識別子: type

識別子: { "propertyName":"type", "mapping":{ "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth", "OCI_RESOURCE_PRINCIPAL":"#/components/schemas/OCIResourcePrincipalAuth" } }
type(required): string

許容値: [ "OCI_NATIVE" ]

記憶域のタイプ。

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

ネストされたスキーマ : OCINativeStorage-allOf[1]

Type: object

ソースを表示

bucket: string

OCIオブジェクト・ストレージのストレージ・バケットの名前。
bucketOciNamespace: string

ストレージ・バケットが存在するネームスペース。バケットが別のテナンシにある場合にのみ必要です。
bucketOciRegion: string

ストレージ・バケットが存在するリージョン。バケットが別のリージョンにある場合にのみ必要です。

{
    "type":"object",
    "properties":{
        "bucket":{
            "type":"string",
            "description":"Name of a storage bucket in OCI object storage."
        },
        "bucketOciRegion":{
            "type":"string",
            "description":"Region where the storage bucket exists. Only required when the bucket is located in a different region."
        },
        "bucketOciNamespace":{
            "type":"string",
            "description":"Namespace where the storage bucket exists. Only required when the bucket is located in a different tenancy."
        }
    }
}

ネストされたスキーマ : Discriminator: type

Type: object

識別子: type

弁別子の値

OSS_AUTH_OCI_USER_ID
OCI_RESOURCE_PRINCIPAL

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

1つのスキーマに一致

ソースを表示

OCIUserIdAuth

非推奨のOracle Cloud Infrastructure (OCI)ユーザーID認証の詳細。 [API署名の生成方法Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two)]を参照してください。
OCIResourcePrincipalAuth

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

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

ネストされたスキーマ : OCIUserIdAuth

非推奨のOracle Cloud Infrastructure (OCI)ユーザーID認証の詳細。 [API署名の生成方法Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two)]を参照してください。

すべてに一致

ソースを表示

object 「認証」

認証の詳細。
object OCIUserIdAuth-allOf[1]

{
    "deprecated":true,
    "description":"Deprecated, 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":"Base64URL encoded private key."
                }
            }
        }
    ],
    "required":[
        "ociRegion",
        "ociTenancyId",
        "ociUserId"
    ]
}

ネストされたスキーマ : OCIResourcePrincipalAuth

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

すべてに一致

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

ソースを表示

object 「認証」

認証の詳細。
object OCIResourcePrincipalAuth-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) Resource Principal authentication details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Auth"
        },
        {
            "type":"object"
        }
    ]
}

ネストされたスキーマ : 認証

Type: object

認証の詳細。

ソースを表示

type(required): string

許容値: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

認証のタイプ。

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

ネストされたスキーマ : OCIUserIdAuth-allOf[1]

Type: object

ソースを表示

ociKeyFingerprint: string

公開キーのフィンガープリント。
ociPrivateKeyWrapped: string

Base64URLエンコードされた秘密キー。
ociRegion: string

OCIリージョンの名前。
ociTenancyId: string

テナンシのOCID。
ociUserId: string

ユーザーのOCID。

{
    "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":"Base64URL encoded private key."
        }
    }
}

ネストされたスキーマ : OCIResourcePrincipalAuth-allOf[1]

Type: object

ネストされたスキーマ : PasswordBar

パスワードで保護されたスナップショットBARファイル。

すべてに一致

パスワードで保護されたスナップショットBARファイル。

ソースを表示

object 「棒」

スナップショットBARファイル。
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 snapshot. The password must be between 14 and 50 characters long and contain at least one numeric character, one uppercase letter, one lowercase letter, and one special character."
                }
            }
        }
    ]
}

ネストされたスキーマ : 棒

Type: object

スナップショットBARファイル。

ソースを表示

uri: string

ストレージ内のBARファイルのURI。

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

ネストされたスキーマ : PasswordBar-allOf[1]

Type: object

ソースを表示

password: string

スナップショットのパスワード。パスワードは14文字から50文字の長さで、1つ以上の数字、1つの大文字、1つの小文字および1つの特殊文字を含める必要があります。

{
    "type":"object",
    "properties":{
        "password":{
            "type":"string",
            "description":"Password of the snapshot. The password must be between 14 and 50 characters long and contain at least one numeric character, one uppercase letter, one lowercase letter, and one special character."
        }
    }
}

ネストされたスキーマ : RegisterSnapshot-allOf[1]

Type: object

ソースを表示

bar: object Bar

スナップショットBARファイル。

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

先頭に戻る

レスポンス

202レスポンス

非同期操作が開始されました。

ヘッダー

oa-work-request-id:

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): 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"
    ]
}

先頭に戻る

例

新しいスナップショットを作成するか("type": "CREATE")、既存のスナップショットを登録できます("type": "REGISTER")。

例1 (type=CREATE): Oracle Analyticsインスタンスの新規スナップショットを作成し、クラウド・ストレージにスナップショットを保存して、そのスナップショットをOracle Analyticsインスタンスに登録します。
例2 (type=REGISTER): クラウド・ストレージの既存のスナップショットをOracle Analyticsインスタンスに登録します。

どちらの場合も、新しいスナップショット・ファイルを保存するか、既存のスナップショット(BARファイル)が格納されるOracle Cloud Infrastructureストレージ・バケットの接続情報を指定する必要があります。

例1 スナップショットの作成と登録

この例では、Oracle Analytics Cloudインスタンスのスナップショット(BARファイル)を作成し、新しいBARファイルをOracle Cloud Infrastructure Object Storageに保存して、スナップショットをOracle Analyticsインスタンスに登録します。

cURLの例

最初に、スナップショットの作成および登録に必要なプロパティを含むJSONファイルを作成します(typeプロパティをCREATEに設定します)。

まだ作成していない場合は、スナップショット・ストレージに適したバケットを作成し、Oracle Analytics Cloudインスタンスにバケットへの読取りおよび書込みアクセス権を付与するIAMポリシーを作成する必要があります。「前提条件」を参照してください。バケットがOracle Analytics Cloudインスタンスと同じリージョンまたはネームスペースにない場合は、パラメータbucketOciRegionおよびbucketOciNamespaceを使用してこれらのロケーションを指定します。

スナップショットのパスワードを指定する場合は、長さが14から50文字で、数字、大文字、小文字および特殊文字が少なくとも1つ含まれていることを確認してください。使用可能な特殊文字には次のものがあります: !#$%&'()+,-./:;<=>?@[]^_`{|}~*。

たとえば、次のようにnew_snapshot.jsonというJSONファイルを作成します:

{
    "type": "CREATE",
    "name": "myfirstsnapshot",
    "storage": {
        "type": "OCI_NATIVE",
        "bucket": "mysnapshot-bucket",
        "bucketOciRegion": "uk-london-1",
        "bucketOciNamespace": "idaabb1122xxyyzz",
        "auth": {
            "type": "OCI_RESOURCE_PRINCIPAL"
        }
    },
    "bar": {
        "uri": "file:///myfolder/myfirstsnapshot.bar",
        "password": "snapshotPassword123!"
    }
}

次に、JSONファイルをコールするcURLコマンドを実行します(例: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

ノート:

Oracleでは、前述の例に示すように、リソース・プリンシパルを使用してスナップショット・ストレージへのアクセスを認証し、auth typeをOCI_RESOURCE_PRINCIPALに設定することをお薦めします。ユーザー・プリンシパル認証(API署名キー)を使用する場合は、次の追加パラメータとともに値OSS_AUTH_OCI_USER_IDを使用します:

"auth": {
            "type": "OSS_AUTH_OCI_USER_ID",
            "ociRegion": "uk-london-1",
            "ociTenancyId": "ocid1.tenancy.oc1..aaaaa...",
            "ociUserId": "ocid1.user.oc1..aaaaaaaayuvg...",
            "ociKeyFingerprint": "ae:df:79:d2:...",
            "ociPrivateKeyWrapped": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tL..."
        }

例2 既存のスナップショットを登録

この例では、以前にOracle Cloud Infrastructure Object Storageにアップロードしたスナップショット(BARファイル)をOracle Analyticsインスタンスに登録します。クラウド・ストレージのスナップショットからOracle Analyticsインスタンスをリストアする場合は、Oracle Analyticsインスタンスにスナップショットを登録する必要があります。

cURLの例:

例1と同様に、登録するBARファイルの指定に必要なプロパティを含むJSONファイルを作成します(typeプロパティをREGISTERに設定します)。

たとえば、次のようにregistermy_snapshot.jsonというJSONファイルを作成します:

{
    "type": "REGISTER",
    "name": "mysavedsnapshot",
    "storage": {
        "type": "OCI_NATIVE",
        "bucket": "mysnapshot-bucket",
        "bucketOciRegion": "uk-london-1",
        "bucketOciNamespace": "idaabb1122xxyyzz",
        "auth": {
            "type": "OCI_RESOURCE_PRINCIPAL"
        }
    },
    "bar": {
        "uri": "file:///myfolder/mysavedsnapshot.bar"
    }
}

次に、JSONファイルをコールするcURLコマンドを実行します(例: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

レスポンス・ヘッダーの例

レスポンス・ヘッダーのoa-work-request-idを書き留めます。この値を使用して、操作のステータスを追跡できます。

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

レスポンス本文の例

または、レスポンス本文のworkRequestIdを書き留めます。この値を使用して、操作のステータスを追跡します。

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

先頭に戻る