機械翻訳について
  1. Oracle Integration 3のDeveloper API
  2. タスク
  3. 統合
  4. 監視

統合インスタンスの取得

get

/ic/api/integration/v1/monitoring/instances

最終更新時間で順序付けられた過去の時間の統合インスタンスに関する情報を取得します。 問合せフィルタ・パラメータのbusinessIDValue、primaryValue、secondaryValueおよびtertiaryValue属性を使用して、複数単語値検索を実行できます。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 たとえば、'"Test-instance1"'、'"Testing instance2"'などです。 指定したprimaryName、secondaryNameおよびtertiaryName変数名に対して、primaryValue、secondaryValueおよびtertiaryValueの値を検索することもできます。

リクエスト

問合せパラメータ
  • 問合せ結果をいくつかのフィールドに制限します。 有効な値は、runId、idおよびallです。

    • 統合名によって結果をグループ化します。 有効な値: integration.

  • これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
  • 返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4番目のアイテムから始まる結果をリストすることを示し、リストには16個のアイテムが含まれます。
  • 戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 デフォルト値は0です。 たとえば、offset=3&limit=16は4番目のアイテムの結果をリストすることを示し、リストには16個のアイテムが含まれます。

    • 実行時間、作成日および最終更新日でソートされます。 有効な値は、lastupdateddate、creationdateおよびexecutiontimeです。 デフォルト値はlastupdateddateです。

  • フィルタ・パラメータ

    • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. デフォルト値は1hです。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
    • code: 統合識別子。
    • version: 統合バージョン。
    • minDuration: ミリ秒単位で指定された最小期間実行されたインスタンスを取得します。
    • maxDuration: ミリ秒単位で指定された最大期間実行されたインスタンスを取得します。
    • status: 統合インスタンスのステータス。 有効な値はCOMPLETED、FAILEDおよびABORTEDです。
    • startdate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲開始日時。 Oracle Integrationインスタンス・データ保存期間の32日範囲内の任意の日付を選択できます。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
    • enddate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲終了日時。 Oracle Integrationインスタンス・データ保存期間の32日範囲内の任意の日付を選択できます。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
    • primaryValue: プライマリ変数値全体を検索します。 複数ワード検索を実行するには、検索値を二重引用符で囲みます。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[test-instance1]', and '[testinginstance2]'. 変数値にアンダースコア文字(test_instanceなど)が含まれている場合は、完全な単語test_instanceを使用して検索する必要があります。 アンダースコア文字を含む変数値の単語の一部を使用して検索する場合、検索では一致するレスポンスは表示されません。
    • secondaryValue: セカンダリ変数値および3次変数値の間で検索されます。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[test-instance1]', and '[testinginstance2]'. 正確なセカンダリ・トラッキング変数値を検索するには、secondaryValueに加えてsecondaryNameを使用します。 変数値にアンダースコア文字(test_instanceなど)が含まれている場合は、完全な単語test_instanceを使用して検索する必要があります。 アンダースコア文字を含む変数値の単語の一部を使用して検索する場合、検索では一致するレスポンスは表示されません。
    • tertiaryValue: セカンダリ変数値および3次変数値の間で検索されます。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[test-instance1]', and '[testinginstance2]'. 正確な3次トラッキング変数値を検索するには、tertiaryValueに加えてtertiaryNameを使用します。 変数値にアンダースコア文字(test_instanceなど)が含まれている場合は、完全な単語test_instanceを使用して検索する必要があります。 アンダースコア文字を含む変数値の単語の一部を使用して検索する場合、検索では一致するレスポンスは表示されません。
    • primaryName: プライマリ変数名。
    • secondaryName: セカンダリ変数名。
    • tertiaryName: 3番目の変数名。
    • businessIDValue: プライマリ変数、セカンダリ変数および3次変数値全体を検索します。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 たとえば、「uyt-atz」です。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[Test-instance1]', and '[Testinginstance2]'. 変数値にアンダースコア文字(test_instanceなど)が含まれている場合は、完全な単語test_instanceを使用して検索する必要があります。 アンダースコア文字を含む変数値の単語の一部を使用して検索する場合、検索では一致するレスポンスは表示されません。
    • jobid: エラーが発生した統合インスタンスの一括再発行に対応するリカバリ・ジョブ識別子。
    • runId: スケジュール済統合インスタンスの実行識別子。
    • requestId: スケジュール済オーケストレーションにのみ適用されます。 統合インスタンスをトリガーしたリクエストのID。
    • id: 統合インスタンス識別子
    • instanceId: 統合インスタンス識別子
    • includePurged: パージされたインスタンスをフェッチするかどうかを示します。 有効な値は、yes、noおよびonlyPurgedです。
    • parentInstanceId: ローカルで起動された子統合インスタンスを検索する親統合の統合インスタンス識別子。
    • projectCode: プロジェクト識別子。
    • integration-style: 統合スタイル識別子。 有効な値はappdriven/scheduledです。

    例: 

    {timewindow:'1h', id:'118', status:'FAILED', code:'ERROR', version:'01.00.0000', requestId:'2432', jobid:'18'}
  • レスポンス・データを制御します。 有効なURLパラメータ値は:

    • メタダタミン: レスポンスにはインスタンスのメタデータが含まれ、instanceId、integrationId、integrationVersion、ステータスなどの詳細で構成されます。 レスポンスには、統合名およびプロジェクト名は含まれません。 より高速なレスポンスが必要な場合は、このパラメータを使用します。
    • メタデータ: レスポンスには、instanceId、integrationId、integrationVersion、ステータスなどのインスタンスのメタデータが含まれます。 また、メタデータには、統合名およびプロジェクト名(使用可能な場合)も含まれます。
    • 最小: レスポンスに統合名とプロジェクト名が含まれていません。 レスポンスにはインスタンス・データの最小情報が含まれているため、レスポンス時間はデフォルトのAPIコールより高速になります。 このレスポンスでは、属性integrationNameおよびprojectFoundはデフォルトに設定されており、依存しないでください。 完全なインスタンス・データの可用性ではなく高速なレスポンスが必要な場合は、このURLパラメータを使用します。
    • summary: デフォルトのレスポンスには、プライマリ以外のトラッキング変数は含まれません。

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ : InstancesRs
型: object
ソースを表示
ネストされたスキーマ : integration-items
型: array
統合インスタンスのリスト
ソースを表示
ネストされたスキーマ: items
型: array
インスタンスのリスト
ソースを表示
ネストされたスキーマ: Object
型: object
ネストされたスキーマ : InstanceRs
型: object
ソースを表示
ネストされたスキーマ : activity-stream
型: array
アクティビティ・ストリーム
ソースを表示
ネストされたスキーマ : audit-trail
型: array
監査証跡
ソースを表示
ネストされたスキーマ : trackings
型: array
トラッキング・データのリスト
ソースを表示
ネストされたスキーマ : TrackingDataRs
型: object
ソースを表示

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー
トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、統合インスタンスに関するモニタリング詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: すべての統合インスタンスの詳細を取得

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

例: 過去3日間のコードSC2RNSYNCを大文字または小文字と統合するためのすべての統合インスタンスに関する詳細を取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={code : 'SC2RNSYNC', timewindow : '3d'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

例: 指定のリクエストIDによってトリガーされた、スケジュールされたオーケストレーション・インスタンスに関する詳細を取得

スケジュール済オーケストレーションにのみ適用されます。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={requestId: '1234', timewindow : '3d'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

例: 戻される結果のページ番号付け

limitおよびoffsetでページ区切りが行われます。 この例では、4番目のアイテムから開始して統合インスタンスをリストします。 リストには16アイテムが含まれます。 

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

例: 結果をrunIdフィールドのみに制限

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "fields=runId'" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

例: パラメータの結合

問合せパラメータを組み合せるには、qで--data-urlencodeオプションを使用します。 その他のパラメータは、-dオプションの後に追加できます。 

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={code : 'SC2RNSYNC', timewindow : '3d'}" -d "offset=3&limit=16" -d "fields=id" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance
先頭に戻る