エラーが発生したインスタンスの取得
get
/ic/api/integration/v1/monitoring/errors
過去1時間にエラー・ステータスになったすべての統合インスタンスに関する情報を、統合インスタンスの最終更新時間順に取得します。 統合インスタンス識別子、フォルト識別子、統合詳細、エラー詳細および再試行回数などの情報を取得します。 エラーが接続で発生した場合は、接続情報が含まれます。 問合せフィルタ・パラメータのbusinessIDValue、primaryValue、secondaryValueおよびtertiaryValue属性を使用して、複数単語値検索を実行できます。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 検索には、エラー・メッセージおよび詳細なエラー・メッセージが含まれます。 たとえば、'"Test-instance1"'、'"Testing instance2"'などです。 指定したprimaryName、secondaryNameおよびtertiaryName変数名に対して、primaryValue、secondaryValueおよびtertiaryValueの値を検索することもできます。
リクエスト
問合せパラメータ
- expand: string
- 統合に関するレスポンスまたは接続についての追加詳細が含まれます。 有効な値: integration, connection.
- groupBy: string
- グループ化の結果(メッセージ、統合名または接続名)。 有効な値: messages, integration, connection.
- integrationInstance(required): string
これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
- limit: integer(int32)
返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるエラー・インスタンスをリストすることを示し、リストには16個のアイテムが含まれます。
- offset: integer(int32)
戻される結果のページ区切りには、制限パラメータを使用します。 デフォルトは0です。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるリストを示し、リストには16個のアイテムが含まれます。
- q: string
フィルタ・パラメータ
- timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. デフォルト値は1hです。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
- code: 統合識別子。
- orderBy: 作成日と最終更新日でソートします。 有効な値はlastupdateddateおよびcreationdateです。 デフォルト値はlastupdateddateです。
- version: 統合バージョン。
- startdate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲開始日時。 Oracle Integrationインスタンス・データ保存期間の32日範囲内の任意の日付を選択できます。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
- enddate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲終了日時。 Oracle Integrationインスタンス・データ保存期間の32日範囲内の任意の日付を選択できます。 Oracleでは、必要な期間にできるだけ近い時間枠および日付範囲値を使用することをお薦めします。
- id: 統合インスタンス識別子。
- instanceId: 統合インスタンス識別子
- 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を使用して検索する必要があります。 アンダースコア文字を含む変数値の単語の一部を使用して検索する場合、検索では一致するレスポンスは表示されません。
- errorMessage: すべてのエラー・インスタンスを検索し、指定された短いエラー・メッセージ・ワードと一致します。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 たとえば、「uyt-atz」です。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[test-instance1]', and '[testinginstance2]'.
- errorDetails: すべてのエラー・インスタンスを検索し、指定されたエラー・メッセージ・ワードと一致します。 複数単語検索を実行するには、検索値を二重引用符で囲み、続けて一重引用符で囲みます。 たとえば、「uyt-atz」です。 完全一致検索を実行するには、検索値を大カッコで囲み、その後に一重引用符で囲みます。 For example, '[test-instance1]', and '[testinginstance2]'.
- リカバリ可能: リカバリ可能なインスタンスとリカバリ不能なインスタンスのどちらをフェッチするかを示します。 有効な値はtrue/falseです。
- includePurged: パージされたインスタンスをフェッチするかどうかを示します。 有効な値は、yes、noおよびonlyPurgedです。
- projectCode: プロジェクト識別子。
- connectionCode: 接続識別子。
- integration-style: 統合スタイル識別子。 有効な値はappdriven/scheduledです。
例:
{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', code:'ERROR', version:'01.00.0000', recoverable:'true', id:'118'} - return: string
レスポンス・データを制御します。 有効な値は最小です。 たとえば、return=minimalです。 この値を指定すると、インスタンス・データの最小限の情報がレスポンスに追加されるため、レスポンス時間はデフォルトのAPIコールより短くなります。 このレスポンスでは、属性integration.nameおよびintegrationDeletedはデフォルトに設定され、依存しないでください。 このURLパラメータは、完全なインスタンス・データの可用性ではなくパフォーマンスが優先される場合に推奨されます。
この操作のリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json; charset=utf-8
200レスポンス
操作の成功
ルート・スキーマ : ErrorsRs
型:
ソースを表示
object-
data-fetch-time: string (date-time)
日付フェッチ時間
-
instanceReportingLevel: string
インスタンス・レポート・レベル
-
isPurged: boolean
パージされたインスタンス
-
items: array items
エラーのリスト
-
opcRequestId: string
opcリクエストID
-
time-window: string
時間ウィンドウ
-
total-records-count: integer (int64)
合計レコード数
-
total-results: integer (int64)
結果合計
ネストされたスキーマ : TrackingBaseRs-allOf[2]
型:
ソースを表示
object-
creationDate: string (date-time)
-
lastTrackedTime: string (date-time)
-
primaryName: string
-
primaryValue: string
-
status: string
許容値:
[ "IN_PROGRESS", "SCHEDULE_WAITING", "QUEUED", "SCHEDULE_PAUSED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "UNKNOWN", "RESUBMITTED", "BLOCKED" ]
ネストされたスキーマ : ErrorBaseRs-allOf[3]
型:
ソースを表示
object-
connection: ConnectionErrorRs
-
endPointName: string
-
endPointOperation: string
-
endPointType: string
-
errorActionName: string
-
errorActionType: string
-
errorCode: string
-
errorDetails: string
-
errorLocation: string
-
errorMessage: string
-
faultId: string
-
instanceId: string
-
instanceReportingLevel: string
-
integration: IntegrationBaseRs
-
invokedBy: string
-
isPurged: boolean
-
milestone: string
-
opcRequestId: string
-
projectCode: string
-
projectName: string
-
retryCount: integer (int32)
400レスポンス
パラメータの形式が正しくありません
401レスポンス
未認可
403レスポンス
禁止
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/errors?integrationInstance=service-instance例: すべてのエラー統合インスタンスのモニタリング・データを取得し、統合に関する追加情報を含めます
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=integration" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance例: 統合名別にグループ化されたすべてのエラー統合インスタンスのモニタリング・データを取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "groupBy=integration" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance例: 過去3日間の統合SC2RNSYNCバージョン01.00.0000のエラー・インスタンスに関するモニタリング・データを取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d', code: 'SC2RNSYNC', version: '01.00.0000'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?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/errors?integrationInstance=service-instance例: パラメータの結合
問合せパラメータを組み合せるには、qで--data-urlencodeオプションを使用します。 その他のパラメータは、-dオプションの後に追加できます。
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d}" -d "expand=integration&offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance