はじめに
OCI Data IntegrationではREST APIで呼び出せる処理をRESTタスクとして実行することができます。つまり、REST APIで実行できる様々なOCIサービスを呼び出すことも可能です。以下のblogで、REST APIで呼び出すいくつかのOCIサービスの処理をOCI RESTタスクコレクションとして公開しています。
OCI Rest Task Collection for OCI Data Integration
その中のOCI Object StrageのObjectのコピーを行うRESTタスクを実行してみました。
プロジェクトの作成
あらかじめOCI Data IntegrationでRESTタスクコレクション用のプロジェクトを作成しておきます。
後でワークスペースOCID、プロジェクト・キーが必要になるので、それぞれのページで確認しておきます。
コレクションのロード
コレクションはGithubで公開されています。それをPostmanにインポートし、実行することでOCI Data Integrationにタスクを作成することができます。
Postmanのインストール
こちらからダウンロードしてインストールを行います。Postmanはブラウザ版もありますが、ローカルファイルのインポート/エクスポートに制限があるようなので、デスクトップ版を利用します。
RESTコレクションのダウンロードとインポート
blogで紹介されているダウンロードリンクにアクセスします。CodeからDownload Zipをクリックします。
ダウンロードしたzipファイルをローカルに解凍します。
Postmanを起動し、importを選択します。
Drop anyware to importのfoldersをクリックして、zipファイルを解凍したフォルダを選択します。インポートされるファイルが表示されるので、そのままimportをクリックします。
変数の設定
Importが完了すると左のEnvironmentsにOCI Credentialsが追加されます。選択すると、Variables一覧が表示されるので、各変数のCurrent valueをOCI Data Integrationを利用する環境に適した値に変更して、Saveをクリックします。
各変数はOCICLIを利用するときの設定で利用するものと同じなので、値の確認はチュートリアルやドキュメントが参考になると思います。
| 変数名 | 説明 |
|---|---|
| tenancy_ocid | テナンシーのOCID |
| user_ocid | ユーザーのOCID |
| fingerprint | ユーザに追加された公開キーのフィンガープリント |
| private_key | API署名キーの秘密キーを張り付け |
| region | リージョン識別子 例:ap-tokyo-1 |
設定後は、右上のEnvironments選択のプルダウンからOCI Credentialsを選択し有効にします。
次に左からCollectionsを選択し、Data Integration REST Tasksをクリックします。右に表示されるタブからVariablesを選択し、WORKSPACE_OCIDとPROJECT_KEYのCurrent valueを先に確認したOCI Data IntegrationのワークスペースのOCIDとプロジェクト・キーに、またREGIONをワークスペースがあるregion識別子に変更します。その後Saveをクリックします。
コレクションの実行と確認
Data Integration Rest Tasksのメニューをクリックし、Run Collectionを選択します。実行方法についての編集画面が表示されますが、そのまま実行します。
実行状況や結果が表示されます。成功の場合は200のステータスコードが返されます。
完了すると、OCI Data Integrationのプロジェクトで作成されたRESTタスクが確認できます。
RESTタスクの確認
作成されたRESTタスクを確認してみます。タスク一覧からObject Storage Copy Taskを選択します。
編集画面が表示されます。
1つずつみていきます。
REST API詳細
HTTPメソッドとURLが確認できます。URLはパラメータが使われていてデフォルト値が設定されていることがわかります。
呼び出しているREST APIについてはこちらのドキュメントをご確認ください。
リクエストタブを見ると、RESTコールのときに渡すパラメータのJSONが確認でき、それにもパラメータが利用されていることがわかります。次をクリックします。
POSTの場合はコールのステータスをポーリングで取得することができます。そのURLが設定されています。こちらもREGIONの部分でパラメータが使われています。
認証
認証はリソース・プリンシパルが設定されています。したがって、実行前にリソース・プリンシパルを利用するためのポリシー設定があらかじめ必要となります。
パラメータ
REST API詳細でパラメータが使用されていることを確認しました。そのパラメータを一覧で確認することができます。また編集や新規に作成することも可能です。
タスクの検証
タスクの検証がオプションで可能です。実行すると成功したので、このRESTタスクではリソース・プリンシパルの設定以外は気にする必要はなさそうです。
RESTタスクの公開と実行
タスクの実行にはアプリケーションへの公開が必要です。ここではあらかじめ作成しておいたアプリケーションに公開しましたが、デフォルトで作成されているDefault Applicationでももちろん構いません。
公開結果は、公開先のアプリケーションのパッチで確認できます。
公開が成功したタスクはアプリケーションのタスクに登録されます。登録されたタスクはメニューから実行することができます。
実行をすると、タスクで設定されていたパラメータの確認/編集画面が表示されます。実行する環境に合わせてパラメータを編集し実行します。
実行結果は実行で確認できます。ステータスは成功です！
おわりに
公開されているサンプルを使ってOCIサービスのRESTタスクを実行してみました。OCIサービスの呼び出しお手本としてだけでなく、RESTタスクの設定例としても参照いただくと、ドキュメントの理解がしやすいように思えました。
参考情報
- ドキュメント RESTタスクの操作