REST APIについて
Oracle Analytics CloudのREST APIを使用してプロセスを自動化し、Oracle Analytics Cloudの機能にプログラムでアクセスします。
APIバージョン
エンドポイントのベース・パスには、APIバージョン(20210901など)が含まれます。 新しいスナップショットを作成するPOSTリクエストの例を次に示します:
POST https://<myOACinstance>.analytics.ocp.oraclecloud.com/api/20210901/snapshots
API中断変更ポリシー
Oracleでは、デプロイ済の既存のAPIを削除または変更する前に12か月前に事前通知が提供されるため、コードの更新が必要になります。
認証
Oracle Analytics Cloud REST APIにアクセスするには、OAuth 2.0アクセス・トークンが必要です。 「認証」を参照してください。
スナップショットAPI
スナップショットRESTエンドポイントを使用すると、スナップショット(BARファイル)をプログラムで管理できます。 たとえば、定期的なバックアップ(スナップショット)を取るスクリプトを作成できます。 または、CreateAnalyticsInstance (OCI REST API)を使用してOracle Analytics Cloudインスタンスを作成するスクリプトを記述し、snapshotsを使用してクラウド・ストレージにアップロードしたスナップショットを新しいOracle Analytics Cloudインスタンスに登録し、restoreSnapshotを使用してOracle Analytics Cloudインスタンスの登録済スナップショットのコンテンツをリストアします。
REST APIを使用してスナップショットを管理するには、BI Service Administratorアプリケーション・ロールが必要です。
一部のスナップショット操作は非同期です。 たとえば、restoreSnapshotをコールすると、作業リクエストIDが返されます。 このIDをWorkRequestsエンドポイントのパラメータとして使用して、スナップショット・リストア'job'のステータスを確認できます。
スナップショットはOracle Cloud Infrastructure Object Storageに保存されます。 Oracle Analytics Cloudがスナップショット・ストレージのバケットにアクセスできるように、Oracle Cloud Infrastructure (OCI)で複数の前提条件タスクを完了する必要があります。 「スナップショットREST APIの前提条件」を参照してください。
このAPIのすべての「RESTエンドポイント」のリストを表示できます。