REST API for Oracle Integration

機械翻訳について

統合のモニタリング・データの取得

get

/ic/api/integration/v1/monitoring/integrations

指定した時間ウィンドウ内の合計メッセージ、処理済メッセージ、成功メッセージ、エラー・メッセージおよび中断メッセージの統合のリストをそれぞれの数とともに取得します。

リクエスト

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

application/json; charset=utf-8

問合せパラメータ

limit: integer(int32)

フェッチする統合の数。
offset: integer(int32)

ページ区切りサポートの開始索引。デフォルト値は0です。
orderBy: string
有効な値:
- 'name': 結果は統合名で順序付けされます。
- 'time': 結果は最終更新時間で順序付けされます。
例:
名前でレコードを並べ替えるには
```
orderBy='name'
```
q: string
フィルタ・パラメータ
- timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. デフォルト値は1hです。
- status: CONFIGURED, ACTIVATION_INPROGRESS, FAILEDACTIVATION, ACTIVATED, ALL. デフォルト値はACTIVATEDです。
- startdate: 統合をフィルタリングするためのUTC形式のカスタム時間範囲開始日時。
- enddate: 統合をフィルタリングするためのUTC形式のカスタム時間範囲終了日時。
- name: 統合名 - 名前の完全検索と部分検索の両方がサポートされています。
- style: 統合のスタイル
  - 'freeform_mapmydata' - アプリケーション駆動オーケストレーション
  - 'freeform_scheduled' - 予定されているオーケストレーション
  - 'template_mapmydata' - 基本的なルーティング
  - 'template_subscribetooic' - OICをサブスクライブ
  - 'template_publishtooic' - OICへの公開
例:
```
{timewindow:'2d', status:'CONFIGURED', style:'freeform_scheduled'}
```
return: string

返すレコードのタイプ。

トップに戻る

レスポンス

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

application/json; charset=utf-8
application/vnd.oracle.resource+json;type=collection

200レスポンス

操作の成功

ルート・スキーマ : MonitoringIntegrationsRs

型: object

ソースを表示

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

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

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

型: array

ソースを表示

Array of: object MonitoringIntegrationBaseRs

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

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

型: array

ソースを表示

Array of: object SuiteLink

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

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

型: object

ソースを表示

code: string
flowStatus: string
id: string
lastUpdated: string(date-time)
lastUpdatedString: string
links: array links
mepType: string
name: string
nextRunDateString: string
noOfErrors: integer
noOfMsgsProcessed: integer
noOfMsgsReceived: integer
noOfSuccess: integer
optimizedVersion: string
scheduleApplicable: boolean

デフォルト値: false
scheduleDefined: boolean

デフォルト値: false
scheduleStatus: string
status: string
successRate: number
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"
        },
        "noOfMsgsReceived":{
            "type":"integer"
        },
        "noOfMsgsProcessed":{
            "type":"integer"
        },
        "noOfErrors":{
            "type":"integer"
        },
        "noOfSuccess":{
            "type":"integer"
        },
        "successRate":{
            "type":"number"
        },
        "scheduleApplicable":{
            "type":"boolean",
            "default":false
        },
        "scheduleDefined":{
            "type":"boolean",
            "default":false
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "optimizedVersion":{
            "type":"string"
        },
        "lastUpdatedString":{
            "type":"string"
        },
        "scheduleStatus":{
            "type":"string"
        },
        "nextRunDateString":{
            "type":"string"
        },
        "flowStatus":{
            "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レスポンス

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

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/integrations

例: アクティブ化されてから前日のすべての統合のモニタリング・データを取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '1d'}" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations

例: アクティブ化されているすべての統合のモニタリング・データを、統合名別にアルファベット順に表示

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

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

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/integrations

例: パラメータの結合 - 統合名ごとの過去1日のモニタリング・データをアルファベット順に取得

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

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '1d'}" -d "orderBy=name" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations

先頭に戻る