REST API for Oracle Integration

エラーが発生したインスタンスの取得

get

/ic/api/integration/v1/monitoring/errors

過去1時間にエラー・ステータスになったすべての統合インスタンスに関する情報を、統合インスタンスの最終更新時間順に取得します。統合インスタンス識別子、フォルト識別子、統合詳細、エラー詳細および再試行回数などの情報を取得します。エラーが接続で発生した場合は、接続情報が含まれます。

リクエスト

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

application/json; charset=utf-8

問合せパラメータ

expand: string
- 統合に関するレスポンスまたは接続についての追加詳細が含まれます。有効な値: integration, connection.
デフォルト値: integration
groupBy: string
- グループ化の結果(メッセージ、統合名または接続名)。有効な値: messages, integration, connection.
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: 統合識別子。
- version: 統合バージョン。
- startdate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲開始日時。 Oracleでは、要件にできるだけ近い開始日を指定することをお薦めします。
- enddate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲終了日時。 Oracleでは、要件にできるだけ近い終了日を指定することをお薦めします。
- id: 統合インスタンス識別子。
- primaryValue: プライマリ・トラッキング変数の値。
- secondaryValue: セカンダリ・トラッキング変数の値。
- tertiaryValue: 第3トラッキング変数の値。
- リカバリ可能: リカバリ可能なインスタンスとリカバリ不能なインスタンスのどちらをフェッチするかを示します。有効な値はtrue/falseです。
例:
```
{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', code:'ERROR', version:'01.00.0000', recoverable:'true', id:'118'}
```

トップに戻る

レスポンス

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

application/json; charset=utf-8

200レスポンス

操作の成功

ルート・スキーマ : errors

型: object

ソースを表示

dataFetchTime: string(date-time)
items: array items
links: array links
timeWindow: string
totalRecordsCount: integer(int64)
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "timeWindow":{
            "type":"string"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"errors"
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

Array of: object error

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ErrorRs"
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

ネストされたスキーマ : error

型: object

ソースを表示

connection: object ConnectionErrorRs
creationDate: string(date-time)
errorDetails: string
errorMessage: string
faultId: string
id: string
integration: object IntegrationBaseRs
integrationDeleted: boolean

デフォルト値: false
isDataAccurate: boolean

デフォルト値: false
lastTrackedTime: string(date-time)
links: array links
primaryName: string
primaryValue: string
recoverable: boolean

デフォルト値: false
retryCount: integer(int32)
runId: string
status: string

許容値: [ "IN_PROGRESS", "FAILED", "COMPLETED", "ABORTED", "RECOVERING", "UNKNOWN", "RESUBMITTED" ]

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastTrackedTime":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "RECOVERING",
                "UNKNOWN",
                "RESUBMITTED"
            ]
        },
        "primaryName":{
            "type":"string"
        },
        "primaryValue":{
            "type":"string"
        },
        "integration":{
            "$ref":"#/definitions/IntegrationBaseRs"
        },
        "connection":{
            "$ref":"#/definitions/ConnectionErrorRs"
        },
        "errorMessage":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        },
        "faultId":{
            "type":"string"
        },
        "retryCount":{
            "type":"integer",
            "format":"int32"
        },
        "recoverable":{
            "type":"boolean",
            "default":false
        },
        "runId":{
            "type":"string"
        },
        "integrationDeleted":{
            "type":"boolean",
            "default":false
        },
        "isDataAccurate":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"error"
    }
}

ネストされたスキーマ : ConnectionErrorRs

型: object

ソースを表示

appTypeDisplayName: string
appTypeVersion: string
displayName: string
id: string
links: array links
majorVersion: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "majorVersion":{
            "type":"string"
        },
        "appTypeDisplayName":{
            "type":"string"
        },
        "appTypeVersion":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : IntegrationBaseRs

型: object

ソースを表示

code: string
id: string
links: array links
mepType: string
name: string
status: string
version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ: Link

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400レスポンス

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

401レスポンス

未認可

403レスポンス

禁止

500レスポンス

サーバー・エラー

トップに戻る

例

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

例: すべてのエラー統合インスタンスのモニタリング・データを取得

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

例: すべてのエラー統合インスタンスのモニタリング・データを取得し、統合に関する追加情報を含めます

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=integration"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

例: 統合名別にグループ化されたすべてのエラー統合インスタンスのモニタリング・データを取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "groupBy=integration"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

例: 過去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://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

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

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

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

例: パラメータの結合

問合せパラメータを組み合せるには、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://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

先頭に戻る