15.1 ORDSを使用したRESTサービスの構成

Oracle Trace File Analyzerには、HTTPSを介した呼出しおよび問合せを可能にするRESTサポートが含まれています。

RESTサービスを構成するtfactl restコマンドライン・オプション

構文

このRESTサポートを容易にするため、Oracle REST Data Services (ORDS)がインストールに含まれています。

tfactl rest [-status|-start|-stop|] [-dir dir] [-port port] [-user user] [-debug [-level]]

注意:

RESTコマンドはrootユーザーとしてのみ実行できます。

パラメータ

表15-1 RESTコマンドのパラメータ

パラメータ 説明

-status

現在のステータスを出力します。

-start

Oracle Trace File AnalyzerのRESTサービスを起動します(まだ実行されていない場合)。

-stop

Oracle Trace File AnalyzerのRESTサービスが実行中の場合は停止します。

–dir dir

Oracle Trace File AnalyzerのREST構成の詳細を格納するために使用するディレクトリを指定します。

ユーザーのホーム・ディレクトリにデフォルト設定されます。

–port port

ORDSを実行するポートを指定します。

デフォルトは9090です。

-user user

ORDSを実行するユーザーを指定します。

デフォルトはGRID所有者です。

–debug

デバッグを有効にします。

–level

使用するデバッグのレベル。使用可能なレベルは次のとおりです。
  • 1 – 致命的

  • 2 – エラー

  • 3 - 警告

  • 4 – 情報(デフォルト)

  • 5 – デバッグ

  • 6 – トレース

ORDSの実行後、次のAPIを使用し、次の形式のリクエストを使用してRESTを呼び出すことができます。
https://host:port/ords/api
次に例を示します。
https://host:port/ords/tfactl/print/status

RESTの認証

Oracle Trace File AnalyzerのRESTは、ファースト・パーティCookieベースの認証(基本認証)を使用します。

Oracle Trace File AnalyzerのRESTアプリケーションは、Webアプリケーションが使用しているものと同じCookieセッションを使用し、RESTful APIに自身を認証し、権限を付与することが可能です。ファースト・パーティのアプリケーションにはRESTful APIへの完全なアクセス権があります。

Oracle Trace File Analyzerは、起動時にtfaadminユーザーおよびtfarestユーザーのパスワードの入力を求めます。

  • RESTコールにはtfarestユーザーを使用します

  • RESTコールの作成、およびRESTサービスの管理(たとえば、ロギング・レベルの変更)には、tfaadminを使用します

# tfactl rest -start

Configuring TFA REST Services using ORDS : 

This might take couple of minutes. Please be patient.

Adding Dependency Jars to ORDS

Adding users to ORDS :

Enter a password for user tfaadmin: 
Confirm password for user tfaadmin: 

Enter a password for user tfarest: 
Confirm password for user tfarest: 

Starting TFA REST Services

Successfully started TFA REST Services [PID : 32650]

URL : https://myserver:9090/ords/tfactl/print/status
次のURLを使用してブラウザからWebサービスにアクセスします。
https://host_name:9090/ords/tfactl/print/status

サインイン・リンクを含む401メッセージが表示されます。リンクをクリックし、作成したtfarest資格証明を使用してサインインすると、REST出力に遷移します。

または、curlコマンドで資格証明を指定することもできます。

# curl -k --user tfarest:mypassword https://myserver:9090/ords/tfactl/print/status
[ {
  "status" : "CheckOK",
  "hostname" : "myserver",
  "pid" : 2430,
  "port" : 5000,
  "version" : "latest-version",
  "buildId" : "latest-build-ID",
  "inventoryStatus" : "COMPLETE"
} ]