2. 診断データの収集
  3. RESTサービスの使用

4.8 RESTサービスの使用

RESTサービスの構成とRESTサービスAPIの使用方法について学習します。

ノート:

AHF RESTは非推奨であり、AHFリリース24.3.0ではサポートされなくなります。ORDSをダウンロードし、AHF RESTサービスを開始するためのORDS.warパスを指定します。

親トピック: 診断データの収集

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

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

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

構文

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

tfactl rest [-status|-start|-stop|-upgrade|-uninstall [-dir
directory] [-port port] [-user user]] [-debug [-level debug_level
1-6]]

ノート:

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

パラメータ

表4-29 RESTコマンド・パラメータ

パラメータ 説明

-status

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

-start

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

-stop

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

-upgrade

Oracle Trace File AnalyzerのRESTサービスを最新バージョンにアップグレードします。

-uninstall

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"
} ]

例4-7 tfactl rest -upgrade

tfactl rest -upgrade

Current Build Version : 204000 and Build ID : 20200115221248
Installed TFA Version : 204000 and Build ID : 20210115221248

Upgrading TFA REST Services to TFA installed version 204000

Stopping TFA REST Services [PID : 10572]

Upgrading TFA Jars

Starting TFA REST Services

Successfully started TFA REST Services [PID : 12554]

親トピック: RESTサービスの使用

4.8.2 Apache Tomcatを使用したRESTサービスの構成

Oracle Trace File Analyzerのインストールには、Apache Tomcatを介してRESTサービスを有効にするWebアプリケーション・リソース(WAR)ファイルが含まれています。

Apache Tomcatを使用してRESTサービスを有効にするには、次のようにします。

ノート:

ユーザー・リソースは、アプリケーション・サーバーにtfa.warファイルをデプロイしてRESTサービスを有効にした場合にのみ使用できます。tfactl rest -startコマンドを実行してRESTサービスを有効にした場合、ユーザー・リソースは使用できません。
  1. TFA_HOME/common/jlib/tfa.warにあるWARファイルをTomcatサーバーにデプロイします。
  2. tfaadminユーザーのパスワードを変更します。
    curl -k --user tfaadmin:tfaadmin -X POST "https://host/tfa/tfactl/user/update" '{ "password" : "some_new_password" }'
  3. tfarestユーザーのパスワードを変更します。
    curl -k --user tfarest:tfarest -X POST "https://host/tfa/tfactl/user/update" '{ "password" : "some_new_password" }'
  4. TomcatユーザーをOracle Trace File Analyzerのアクセス・リストに追加します。
    tfactl access add -user tomcat_user

親トピック: RESTサービスの使用

4.8.3 RESTサービスのprint API

RESTサービスのprint APIの使用方法を学習します

  • status
    GETリクエストを使用して、すべてのホストのステータスを出力します。
  • hosts
    GETリクエストを使用して、ホストのリストを出力します。
  • actions
    GETリクエストを使用して、すべてのホストで実行されたアクションのリストを出力します。
  • repository
    GETリクエストを使用して、すべてのホストのリポジトリの詳細を出力します。
  • collections
    GETリクエストを使用して、すべての収集または特定の収集の詳細を出力します。
  • config
    GETリクエストを使用して、すべてのホストの構成の詳細を出力します。
  • protocols
    GETリクエストを使用して、すべてのホストのプロトコルの詳細を出力します。
  • directories
    GETリクエストを使用して、すべてのホストのディレクトリの詳細を出力します。

親トピック: RESTサービスの使用

4.8.3.1 status

GETリクエストを使用して、すべてのホストのステータスを出力します。

構文

/tfactl/print/status

例4-8 print

[ {
  "status" : "CheckOK",
  "hostname" : "myhost",
  "pid" : 73637,
  "port" : 9090,
  "version" : "latest-version",
  "buildId" : "latest-build-ID",
  "inventoryStatus" : "COMPLETE"
} ]

親トピック: RESTサービスのprint API

4.8.3.2 hosts

GETリクエストを使用して、ホストのリストを出力します。

構文

/tfactl/print/hosts

例4-9 hosts

[ {
  "hostname" : "myhost"
} ]

親トピック: RESTサービスのprint API

4.8.3.3 actions

GETリクエストを使用して、すべてのホストで実行されたアクションのリストを出力します。

構文

/tfactl/print/actions

例4-10 actions

[ {
  "actionName" : "Run inventory",
  "hostname" : "Requested in all nodes",
  "client" : "tfactl",
  "startTime" : "Jan 09 07:50:26 PST",
  "endTime" : "Jan 09 07:50:29 PST",
  "status" : "COMPLETE",
  "comments" : null
} ]

親トピック: RESTサービスのprint API

4.8.3.4 repository

GETリクエストを使用して、すべてのホストのリポジトリの詳細を出力します。

構文

/tfactl/print/repository

例4-11 repository

[ {
  "hostname" : "myhost",
  "directory" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository",
  "status" : "OPEN",
  "maxSizeMB" : 10240,
  "currentSizeMB" : 13,
  "freeSpaceMB" : 10227
} ]

親トピック: RESTサービスのprint API

4.8.3.5 collections

GETリクエストを使用して、すべての収集または特定の収集の詳細を出力します。

構文

/tfactl/print/collections
/tfactl/print/collections/{collectionid}

例4-12 collections

[ {
  "id" : "20171010115528myhost",
  "type" : "Manual Collection",
  "requestUser" : "smith",
  "nodeList" : "[]",
  "masterHost" : "myhost",
  "startTime" : "Mon Oct 09 23:55:32 PDT 2017",
  "endTime" : "Tue Oct 10 11:55:32 PDT 2017",
  "tag" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository/tfa_11",
  "zipFileName" : "myhost.tfa_Tue_Oct_10_11_55_28_PDT_2017.zip",
  "componentList" : "[emagent, crsclient, oms, dbwlm,emplugins, cfgtools, afd, wls]",
  "zipFileSize" : 3055,
  "collectionTime" : 16,
  "events" : null
}]
[{
  "id" : "20171011044112myhost",
  "type" : "Manual Collection",
  "requestUser" : "smith",
  "nodeList" : "[]",
  "masterHost" : "myhost",
  "startTime" : "null",
  "endTime" : "Wed Oct 11 04:41:14 PDT 2017",
  "tag" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository/TFA_T1",
  "zipFileName" : "myhost.TFA_T1.zip",
  "componentList" : "[]",
  "zipFileSize" : 0,
  "collectionTime" : 0,
  "events" : null
}]

親トピック: RESTサービスのprint API

4.8.3.6 config

GETリクエストを使用して、すべてのホストの構成の詳細を出力します。

構文

/tfactl/print/config

例4-13 config

[ {
  "hostname" : "myhost",
  "tfaVersion" : "latest-version",
  "javaVersion" : "latest-version",
  "inventoryTraceLevel" : 1,
  "collectionTraceLevel" : 1,
  "scanTraceLevel" : 1,
  "otherTraceLevel" : 3,
  "currentSizeMB" : 13,
  "maxSizeMB" : 10240,
  "maxLogSize" : 50,
  "maxLogCount" : 10,
  "maxCoreFileSize" : 50,
  "maxCoreCollectionSize" : 500,
  "minSpaceForRTScan" : 500,
  "diskUsageMoninterInterval" : 60,
  "manageLogsAutoPurgeInterval" : 60,
  "manageLogsAutoPurgePolicyAge" : "30d",
  "minFileAgeToPurge" : 12,
  "language" : "en",
  "encoding" : "UTF-8",
  "country" : "US",
  "alertLogLevel" : "ALL",
  "userLogLevel" : "ALL",
  "baseLogPath" : "ERROR",
  "tfaIpsPoolSize" : 5,
  "autoPurge" : true,
  "publicIp" : false,
  "fireZipsInRT" : true,
  "rtscan" : true,
  "diskUsageMonOn" : true,
  "manageLogsAutoPurgeOn" : false,
  "trimmingOn" : true
} ]

親トピック: RESTサービスのprint API

4.8.3.7 protocols

GETリクエストを使用して、すべてのホストのプロトコルの詳細を出力します。

構文

/tfactl/print/protocols

例4-14 protocols

{
  "hostname" : "myhost",
  "available" : [ "TLSv1.2" ],
  "restricted" : [ "SSLv3", "SSLv2Hello", "TLSv1", "TLSv1.1" ]}

親トピック: RESTサービスのprint API

4.8.3.8 directories

GETリクエストを使用して、すべてのホストのディレクトリの詳細を出力します。

構文

/tfactl/print/directories

例4-15 directories

[ {
  "hostname" : "myhost",
  "directory" : "/oem/app/oracle/product/emagent/agent_inst/install/logs",
  "components" : [ "EMPLUGINS" ],
  "permission" : "public",
  "owner" : "root",
  "collectionPolicy" : "exclusions",
  "collectAll" : false
}, {
  "hostname" : "myhost",
  "directory" : "/oem/app/oracle/product/emagent/agent_inst/sysman/log",
  "components" : [ "EMAGENT" ],
  "permission" : "public",
  "owner" : "root",
  "collectionPolicy" : "exclusions",
  "collectAll" : false
} ]

親トピック: RESTサービスのprint API

4.8.4 RESTサービスのdiagcollect API

RESTサービスのdiagcollect APIの使用方法を学習します。

  • diagcollect
    POSTリクエストを使用して、収集の詳細を表示します。

親トピック: RESTサービスの使用

4.8.4.1 diagcollect

POSTリクエストを使用して、収集の詳細を表示します。

構文

/tfactl/diagcollect

戻り値

すべてのコンポーネントに関する過去1時間のOracle Trace File Analyzerのデフォルト収集。

または、パラメータとして指定したJSONデータに基づくOracle Trace File Analyzerの収集。

例4-16 diagcollect - デフォルト収集

testuser: {
  "collectionId" : "20190401121115slc13lyb",
  "zipName" : "TFA_DEF_ZIP_20190401121115",
  "tagName" : "TFA_DEF_TAG_20190401121115",
  "message" : [ "Diagcollect request will be processed soon by TFA" ]
}

例4-17 diagcollect - パラメータとしてのJSONデータ

入力:

[{ 
  "components": "-database -asm -tns -crs -acfs -install -cfgtools -os", 
  "timePeriod": "-since n[d|h] | -last n[d|h] | -for date |
        -from date -to date",
  "tagName": "crs_crash_collection",
  "nodeList": "node1,node2",
  "options": "-nocopy | -notrim | -silent | -cores | 
       -collectalldirs | -collectdir dir1,dir2..."
}]

出力:

[{
  "collectionId" : "20180111011121slc12ekf",
  "zipName" : "TFA_DEF_ZIP_20180111011121",
  "tagName" : "TFA_DEF_TAG_20180111011121"
}]

親トピック: RESTサービスのdiagcollect API

4.8.5 RESTサービスのdownload API

RESTサービスのdownload APIの使用方法を学習します。

  • download
    GETリクエストを使用して、特定の収集IDの収集ZIPファイルをダウンロードします。

親トピック: RESTサービスの使用

4.8.5.1 download

GETリクエストを使用して、特定の収集IDの収集ZIPファイルをダウンロードします。

構文

/tfactl/download/{collectionid}

戻り値

指定した収集IDの収集ZIPファイル。

使用上のノート

収集ZIPファイルをダウンロードする収集IDを指定します。

親トピック: RESTサービスのdownload API

4.8.6 RESTサービスのrun API

RESTサービスのrun APIの使用方法を学習します。

  • alertsummary
    GETリクエストを使用して、alertsummaryコマンドを実行します。
  • calog
    GETリクエストを使用して、calogコマンドを実行します。
  • changes
    GETリクエストを使用して、changesコマンドを実行します。
  • events
    GETリクエストを使用して、eventsコマンドを実行します。
  • history
    GETリクエストを使用して、historyコマンドを実行します。

親トピック: RESTサービスの使用

4.8.6.1 alertsummary

GETリクエストを使用して、alertsummaryコマンドを実行します。

構文

/tfactl/run/alertsummary

戻り値

alertsummaryコマンドが実行され、アラート・サマリーが返されます。

例4-18 alertsummary

[ {
  "line" : "Output from host : myserver"
}, {
  "line" : "------------------------------"
}, {
  "line" : "Reading /scratch/app/oradb/diag/rdbms/apxcmupg/apxcmupg_2/trace/alert_apxcmupg_2.log"
}, {
  "line" : "+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-"
}, {
  "line" : "------------------------------------------------------------------------"
}, {
  "line" : "Oct 20 08:20:43 Database started"
}, {
  "line" : "------------------------------------------------------------------------"
}, {
  "line" : "Nov 05 20:27:50 Database started"
},
....
....

親トピック: RESTサービスのrun API

4.8.6.2 calog

GETリクエストを使用して、calogコマンドを実行します。

構文

/tfactl/run/calog

親トピック: RESTサービスのrun API

4.8.6.3 changes

GETリクエストを使用して、changesコマンドを実行します。

構文

/tfactl/run/changes

例4-19 changes

[ {
  "line" : "Output from host : myserver"
}, {
  "line" : "------------------------------"
}, {
  "line" : "[Jul/25/2018 03:45:15.325]: Parameter: fs.aio-nr: Value: 276224 => 277760"
}, {
  "line" : "[Jul/25/2018 03:45:15.325]: Parameter: kernel.random.entropy_avail: Value: 192 => 152"
}, {
  "line" : "[Jul/25/2018 03:45:15.325]: Parameter: kernel.random.uuid: 
Value: 5eac06d7-560a-466d-a035-efe836fe0b57 => 3f329d9c-25d3-4057-ab00-17d031645490"
}, {
  "line" : "[Jul/25/2018 15:46:15.325]: Parameter: fs.aio-nr: Value: 277760 => 279296"
},
....
....

親トピック: RESTサービスのrun API

4.8.6.4 events

GETリクエストを使用して、eventsコマンドを実行します。

構文

/tfactl/run/events

例4-20 events

[ {
  "line" : "Output from host : myserver"
}, {
  "line" : "------------------------------"
}, {
  "line" : "Event Summary:"
}, {
  "line" : "INFO    :0"
}, {
  "line" : "ERROR   :0"
}, {
  "line" : "WARNING :0"
}, {
  "line" : "Event Timeline:"
}, {
  "line" : "No Events Found"
} ]

親トピック: RESTサービスのrun API

4.8.6.5 history

GETリクエストを使用して、historyコマンドを実行します。

構文

/tfactl/run/history

親トピック: RESTサービスのrun API

4.8.7 RESTサービスのuser API

RESTサービスのuser APIの使用方法を学習します。これらのRESTエンドポイントにアクセスするには、tfaadminユーザーとしてログインします。

  • add
    POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスにユーザーを追加します。
  • delete
    POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスのユーザーを削除します。
  • update
    POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスのユーザーのパスワードを更新します。

親トピック: RESTサービスの使用

4.8.7.1 add

POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスにユーザーを追加します。

構文

/tfactl/user/add

例4-21 add

入力:

{
  "userName" : "test",
  "password" : "test"
}

出力:

{
  "status": "SUCCESS",
  "message": "Successfully added test to TFA REST Services"
}

親トピック: RESTサービスのuser API

4.8.7.2 delete

POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスのユーザーを削除します。

構文

/tfactl/user/delete

例4-22 delete

入力:

{
  "userName" : "test"
}

出力:

{
  "status": "SUCCESS",
  "message": "Successfully removed test from TFA REST Services"
}

親トピック: RESTサービスのuser API

4.8.7.3 update

POSTリクエストを使用して、Oracle Trace File Analyzer RESTサービスのユーザーのパスワードを更新します。

構文

/tfactl/user/update

例4-23 update

入力:

{
  "password" : "test"
}

出力:

{
  "status": "SUCCESS",
  "message": "Successfully updated users's profile in TFA"
}

親トピック: RESTサービスのuser API

4.8.8 Oracle REST Data Services (ORDS)の構成

ノート:

現在のリリースでは、Microsoft WindowsでRESTサービスはサポートされていません。

親トピック: RESTサービスの使用

4.8.8.1 RESTを介したOracle Autonomous Health Frameworkコンプライアンスの使用

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

  • check
    GETリクエストを使用して、指定されたチェックIDのヘルス・チェック実行を実行します。
  • checktfafaileduploads
    GETリクエストを使用して、Oracle Autonomous Health Frameworkサービスのアップロードが失敗したかどうかをレポートします。
  • download
    GETリクエストを使用して、指定されたジョブIDの収集結果をダウンロードします。
  • getinfo
    GETリクエストを使用して、指定されたジョブIDのステータスをレポートします。
  • listcollections
    GETリクエストを使用して、RESTを介して生成されたOracle ORAchk収集のリストを取得します。
  • profile
    GETリクエストを使用して、指定されたプロファイルのヘルス・チェック実行を実行します。
  • showrepair
    GETリクエストを使用して、指定されたチェックのshowrepairコマンドをレポートします。
  • start_client
    POSTリクエストを使用して、指定された収集結果の差分を実行します。
  • start_client
    GETリクエストを使用して、通常のヘルス・チェック実行を実行します。
  • start_client
    POSTリクエストおよびGETリクエストを使用し、特定の引数を使用して、通常のヘルス・チェック実行を実行します。
  • status
    GETリクエストを使用して、指定されたジョブIDのステータスをレポートします。
  • uploadtfafailed
    GETリクエストを使用して、以前に失敗したすべてのアップロードをOracle Autonomous Health Frameworkサービスに再度アップロードすることを試行します。
  • version
    GETリクエストを使用して、versionコマンドを実行します。

親トピック: Oracle REST Data Services (ORDS)の構成

4.8.8.1.1 check

GETリクエストを使用して、指定されたチェックIDのヘルス・チェック実行を実行します。

構文

/check/{check_id1,check_id2}

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "ID":"B2PKK9RR9M7MYJPRN8", "Status":"SUBMITTED" }]

使用上のノート

プロファイル、またはチェックIDのカンマ区切りリストを指定します。

例4-24 check

-bash-4.2$ curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/check/E94589BC1AC24CFBE04312C0E50A3849

 
[{"ID":"B2PKK9RR9M7MYJPRN8","Status":"SUBMITTED"}]
4.8.8.1.2 checktfafaileduploads

GETリクエストを使用して、Oracle Autonomous Health Frameworkサービスのアップロードが失敗したかどうかをレポートします。

構文

/checktfafaileduploads

戻り値

アップロードに失敗した収集がない場合は、次の内容が返されます。

[{ "Msg":"There are no Failed collections under ORDS directory." }]

または、アップロードに失敗した収集のリストを出力します。

使用上のノート

このAPIを使用するために入力を指定する必要はありません。

例4-25 checktfafaileduploads

bash-4.1# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/checktfafaileduploads
HTTP/1.1 200 OK
Date: Thu, 19 Jul 2018 10:04:58 GMT
Content-Type: text/html
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked

[{"Msg":"There are no Failed collections under ORDS directory."}]
4.8.8.1.3 download

GETリクエストを使用して、指定されたジョブIDの収集結果をダウンロードします。

構文

/download/{job_id}

戻り値

収集結果のzipバイナリを返します。

使用上のノート

収集結果をダウンロードするジョブIDを指定します。

パージされたIDまたは無効なIDを指定すると、ダウンロードされるファイルにエラー・メッセージが書き込まれます。

例4-26 download

# curl -X GET -k --user tfarest:password  
https://node1.example.com:9090/ords/tfactl/orachk/download/0K5Y5MAX2SD5CPP6SH -O
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 54854    0 54854    0     0   220k      0 --:--:-- --:--:-- --:--:--  221k

# unzip -qo 0K5Y5MAX2SD5CPP6SH

# ls -l
-rw-r--r--. 1 root root 54854 Sep  3 03:30 0K5Y5MAX2SD5CPP6SH
drwxr-xr-x. 1 root root   288 Sep  3 03:30 orachk_node1_orcl2_test_090319_032952_0K5Y5MAX2SD5CPP6SH
4.8.8.1.4 getinfo

GETリクエストを使用して、指定されたジョブIDのステータスをレポートします。

構文

/getinfo/{job_id}

戻り値

IDが存在しない場合は、次のようなJSONを返します。

[{ "Status":"Either the ID entered is invalid or the wallet has been purged." }]

または、IDが存在する場合、修復コマンドを返します。

使用上のノート

ステータスを確認するジョブIDを指定します。

例4-27 getinfo

-bash-4.1# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/getinfo/FJELUT7XYM3AKOE1R4 HTTP/1.1 200 OK Date: Thu, 19 Jul 2018 10:15:34 GMT 
Content-Type: text/html X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked

修復コマンド:

alter database datafile '+DATAC1/RAC12C/DATAFILE/sysaux.314.936528199' autoextend on maxsize unlimited;
4.8.8.1.5 listcollections

GETリクエストを使用して、RESTを介して生成されたOracle ORAchk収集のリストを取得します。

構文

/tfactl/orachk/listcollections

戻り値

RESTを介して生成されたOracle ORAchk収集のリストを返します。

例4-28 listcollections

# curl -k --user tfarest:password  
https://node1.example.com:9090/ords/tfactl/orachk/listcollections | sed s/\<BR\>/\\n/g 
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   581    0   581    0     0   3906      0 --:--:-- --:--:-- --:--:--  3925
List of collections:
/u02/test-user/oracle.ahf/data/node1/tfa/rest/ords/orachk_node1_orcl2_bill_test_090319_034049_BTGP96ZYH45P5LHB86.zip
/u02/test-user/oracle.ahf/data/node1/tfa/rest/ords/orachk_node1_orcl2_bill_test_090319_032952_0K5Y5MAX2SD5CPP6SH.zip
/u02/test-user/oracle.ahf/data/node1/tfa/rest/ords/orachk_node1_orcl2_bill_test_090319_034245_WH9UWZRN9PKPDNKZCL.zip
/u02/test-user/oracle.ahf/data/node1/tfa/rest/ords/orachk_node1_orcl2_bill_test_090319_033349_L05Y28DSOTZ9N73HO0.zip
4.8.8.1.6 profile

GETリクエストを使用して、指定されたプロファイルのヘルス・チェック実行を実行します。

構文

/profile/{profile1},{profile2}

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "ID":"DMBLMBTB2M2H1QCQIS", "Status":"SUBMITTED" }]

使用上のノート

プロファイル、またはスラッシュ(/)で区切られたプロファイルのリストを指定します。

例4-29 profile

-bash-4.2$ curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/profile/asm

HTTP/1.1 200 OK Date: Thu, 05 Apr 2018 10:50:00 GMT Content-Type: text/html X-Frame-Options: 
SAMEORIGIN Transfer-Encoding: chunked Server: Jetty(9.2.z-SNAPSHOT) 
[{"ID":"DMBLMBTB2M2H1QCQIS","Status":"SUBMITTED"}]
4.8.8.1.7 showrepair

GETリクエストを使用して、指定されたチェックのshowrepairコマンドをレポートします。

構文

/showrepair/{check_id}

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "ID":"ZFZLH06WOLE3L92PQI", "Status":"SUBMITTED" }]

使用上のノート

showrepairコマンドのレポート対象となるチェックIDを指定します。

例4-30 showrepair

-bash-4.1# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/showrepair/9ECBA2152E92F6B1E040E50A1EC00DFB
HTTP/1.1 200 OK
Date: Thu, 19 Jul 2018 10:13:54 GMT
Content-Type: text/html
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked

[{"ID":"FJELUT7XYM3AKOE1R4","Status":"SUBMITTED"}]
-bash-4.1# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/status/FJELUT7XYM3AKOE1R4
HTTP/1.1 200 OK
Date: Thu, 19 Jul 2018 10:15:00 GMT
Content-Type: text/html
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked

[{"Msg":"Status of FJELUT7XYM3AKOE1R4 is  COMPLETED"}]
4.8.8.1.8 start_client

POSTリクエストを使用して、指定された収集結果の差分を実行します。

構文

/start_client

戻り値

次のようなJSONを返します。

[{ "ID":"ZFZLH06WOLE3L92PQI", "Status":"SUBMITTED" }]

status APIを使用すると、送信されたジョブIDのステータスを問い合せることができます。次に、download APIを使用して、同じジョブIDを使用して差分レポートをダウンロードできます。

使用上のノート

JSONの入力:

[{ "-diff":"collection_zip_1 collection_zip_2" }]

例4-31 start_client

-bash-4.2$ curl -i -X POST -H "Content-Type: application/json" -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/start_client -d '[{"-diff":"orachk_myhost69_apxcmupg_062118_025029_N1O498NX877LYO5FE3.zip 
orachk_myhost69_apxcmupg_062118_030527_ICMOWECU1UKF0R0VTO.zip"}]'
4.8.8.1.9 start_client

GETリクエストを使用して、通常のヘルス・チェック実行を実行します。

構文

/start_client

戻り値

次のようにジョブIDを示すJSONを返します。

[{
"ID":"UCTW5MLN7O1V1HPG8U",
"Status":"SUBMITTED"
}]

使用上のノート

このAPIを使用するために入力を指定する必要はありません。

例4-32 start_client

-bash-4.2$ curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/start_client

HTTP/1.1 200 OK Date: Thu, 05 Apr 2018 11:53:14 GMT Content-Type: text/html X-Frame-Options: 
SAMEORIGIN Transfer-Encoding: chunked Server: Jetty(9.2.z-SNAPSHOT) 
[{"ID":"UCTW5MLN7O1V1HPG8U","Status":"SUBMITTED"}]
4.8.8.1.10 start_client

POSTリクエストおよびGETリクエストを使用し、特定の引数を使用して、通常のヘルス・チェック実行を実行します。

構文

/start_client

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "ID":"UCTW5MLN7O1V1HPG8U", "Status":"SUBMITTED" }]

使用上のノート

Oracle ORAchkまたはOracle EXAchkの引数と対応する値を指定します。

例4-33 JSON入力

[{
"-clusternodes":"busm1c1,busm1c2",
"-ibswitches":"busm1sw-ibs0,busm1sw-iba0,busm1sw-ibb0"
}]

例4-34 start_client

# curl -i -X POST -H "Content-Type: application/json" -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/start_client -d '[{"-clusternodes":"busm1c1,busm1c2","-ibswitches":"busm1sw-ibs0,busm1sw-iba0,busm1sw-ibb0"}]
# curl -X POST -k --user tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/start_client -d '{"-check": "81586F6DEC0DB43CE053D398EB0AF1EA", "-showpass", ""}'
[{"ID":"0K5Y5MAX2SD5CPP6SH","Status":"SUBMITTED"}]
# curl -X GET -k --user tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/check/81586F6DEC0DB43CE053D398EB0AF1EA
[{"ID":"BTGP96ZYH45P5LHB86","Status":"SUBMITTED"}]
# curl -X GET -k --user tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/profile/asm
[{"ID":"WH9UWZRN9PKPDNKZCL","Status":"SUBMITTED"}]
4.8.8.1.11 status

GETリクエストを使用して、指定されたジョブIDのステータスをレポートします。

構文

/status/{job_id}

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "Status of DMBLMBTB2M2H1QCQIS is SUBMITTED" }]

ステータスは、SUBMITTEDからRUNNING、COMPLETEDに遷移します。

使用上のノート

ステータスを確認するジョブIDを指定します。

例4-35 status

# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/status/DMBLMBTB2M2H1QCQIS

HTTP/1.1 200 OK Date: Thu, 05 Apr 2018 10:51:16 GMT Content-Type: text/html X-Frame-Options: 
SAMEORIGIN Transfer-Encoding: chunked Server: Jetty(9.2.z-SNAPSHOT) 
[{"Status of DMBLMBTB2M2H1QCQIS is SUBMITTED"}]
# curl -X GET -k --user tfarest:password  
https://node1.example.com:9090/ords/tfactl/orachk/status/0K5Y5MAX2SD5CPP6SH
[{"Msg":"Status of 0K5Y5MAX2SD5CPP6SH is RUNNING"}]
# curl -X GET -k --user tfarest:password  
https://node1.example.com:9090/ords/tfactl/orachk/status/0K5Y5MAX2SD5CPP6SH
[{"Msg":"Status of 0K5Y5MAX2SD5CPP6SH is COMPLETED"}]
# curl -X GET -k --user tfarest:password  
https://node1.example.com:9090/ords/tfactl/orachk/status/0K5Y5MAX2SD5CPP6SH
[{"Msg":"Status of 0K5Y5MAX2SD5CPP6SH is COMPLETED"}]
4.8.8.1.12 uploadtfafailed

GETリクエストを使用して、以前に失敗したすべてのアップロードをOracle Autonomous Health Frameworkサービスに再度アップロードすることを試行します。

構文

/uploadtfafailed/all

戻り値

次のようにジョブIDを示すJSONを返します。

[{ "ID":"ZFZLH06WOLE3L92PQI", "Status":"SUBMITTED" }]

使用上のノート

このAPIを使用するために入力を指定する必要はありません。

例4-36 uploadtfafailed

-bash-4.1# curl -i -X GET -k -u tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/uploadtfafailed/all
HTTP/1.1 200 OK
Date: Thu, 19 Jul 2018 10:09:18 GMT
Content-Type: text/html
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked

[{"ID":"0B9O04CKSYZNUZCYZD","Status":"SUBMITTED"}]
4.8.8.1.13 version

GETリクエストを使用して、versionコマンドを実行します。

構文

/tfactl/orachk/version

戻り値

versionコマンドを実行して、Oracle ORAchkデーモンのバージョンを返します。

例4-37 version

# curl -k --user tfarest:password 
https://node1.example.com:9090/ords/tfactl/orachk/version
{"VERSION":"ORACHK  VERSION: 19.3.0_20190902"}

4.8.8.2 含まれているORDSを使用したRESTの構成

シェル環境変数を設定することによって、デフォルトのORDS構成をオーバーライドします。

  • デフォルトでは、Oracle REST Data Services (ORDS)は7080-7085の範囲で使用可能なポートを使用します。この範囲にポートがない場合、ORDSは終了し、RAT_ORDS_PORT環境変数の設定を求めるプロンプトが表示されます。RAT_ORDS_PORTがすでに設定されている場合、ORDSはRAT_ORDS_PORT環境変数で指定されているポートを使用します。

  • デフォルトでは、ORDSは管理者ユーザーordsadminで設定されます。これは、RAT_ORDSADMIN_USER環境変数に別のユーザーを指定することでオーバーライドできます。

  • ORDSは、Oracle ORAchkおよびOracle EXAchkに応じて、ordsorachkまたはordsexachkという名前のnologinユーザーとして起動されます。すでに実行中のORDSを使用する場合、ユーザーはORDSを実行しているユーザーと同じです。

  • Oracle Trace File Analyzerがインストールされている場合、ORDSはTFA_HOMEからJAVA_HOMEを選択します。Oracle Trace File Analyzerがインストールされていない場合、ORDSはデフォルトのJAVA_HOMEを選択します。JDK8を使用する必要があります。ただし、RAT_JAVAEXE環境変数を設定してオーバーライドできます。

親トピック: Oracle REST Data Services (ORDS)の構成

4.8.8.3 既存のORDSインストール環境を使用したRESTの構成

  1. 既存のords.warファイルにorachkrest.jarファイルを追加するには、次のようにします:
    orachk -ordssetup ords_war_dir -configdir config_dir
    exachk -ordssetup ords_war_dir -configdir config_dir

    説明

    ords_war_dirは、ords.warファイルを含むディレクトリです

    config_dirは、ORDS構成ファイルを格納するために指定できるオプションのディレクトリです。オプションのディレクトリを指定しない場合、構成ファイルはorda_war_dirディレクトリに格納されます。

    -ordssetupコマンドを実行した後のORDSの停止および再起動:

    • 既存のords.warファイルにorachkrest.jarファイルを追加します

    • ユーザーordsadminをords.warファイルに追加し、ordsadminに対してORAchk admin権限を付与します

  2. Oracle ORAchkデーモンまたはOracle EXAchkデーモンを起動するには、次のようにします。
    orachk -d start -ords ords_war_dir
    exachk -d start -ords ords_war_dir
完了したら、ords_war_dir/log/ords_setup.logファイルを開き、REST URLの詳細を表示します。

関連トピック

親トピック: Oracle REST Data Services (ORDS)の構成