REST APIリファレンス

前へ次へ

MIJobsリソース

MIJobs

リソースを使用して、使用可能な

ストリーミング統合

ジョブのリストを取得します。

GET要求

使用可能な

ストリーミング統合

ジョブのリストを要求するには、次のURLを使用します。

<server URI>/mijobmonitor/api/v1/MIJobs

URIで以下のクエリパラメータを含めることができます。

パラメータ	タイプ	必須	説明
$count	Boolean	×	データベース内の取り込みジョブの数を表示します。
$filter	String	×	入力に基づいてジョブをフィルタリングします。次のいずれかのフィールドを使用してフィルタできます。 assetName assetType startedBy status 単一または複数のフィールドを使用してジョブをフィルタリングできます。
$orderby	String	×	ジョブの順序を並べ替えます。次のフィールドを使用してジョブを並べ替えることができます。 assetName assetType status runtimeEnv startTime 単一または複数のフィールドを使用してジョブを並べ替えることができます。
$skip	Integer	×	指定したストリーミング取り込みジョブの数をスキップします。例えば、最初の5つのストリーミング取り込みジョブをスキップしたい場合などです。指定している場合は、$filterおよび$orderbyパラメータの値を検討してください。
$top	Integer	×	指定した数の上位ストリーミング取り込みジョブを表示します。例えば、上位10個のストリーミング取り込みジョブを確認したい場合などです。指定している場合は、$filterおよび$orderbyパラメータの値を検討してください。

GET要求の例

使用可能な

ストリーミング統合

ジョブのリストを取得するには、次の例のような要求を送信します。

POST https://usw1-ing.dm2-us.informaticacloud.com/mijobmonitor/api/v1/MIJobs?$count=true&$filter=(startedBy eq 'siqa_new')&$orderby=deployTime desc&$skip=0&$top=25
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT

GET応答

成功した場合はMIJobsオブジェクトが返され、エラーが発生した場合はエラーオブジェクトが返されます。

成功した場合、応答には、

ストリーミング統合

ジョブに関する次の情報が含まれます。

パラメータ	タイプ	説明
assetName	String	ストリーミング統合ジョブの名前。
runId	Integer	ストリーミング統合ジョブの実行ID。IDはデプロイのたびに変わります。
orgId	String	ログインユーザーが属する組織のID。
runtimeEnv	String	ストリーミング統合ジョブをデプロイしたSecure AgentのID。
startTime	Integer	ジョブのデプロイの開始日時（UTC時間）。
endTime	Integer	ジョブのデプロイの終了日時（UTC時間）。
deployTime	Integer	ジョブのデプロイ日時（UTC時間）。
undeployTime	Integer	ジョブのデプロイ解除日時（UTC時間）。
startedBy	Integer	ストリーミング統合タスクを作成したユーザーの名前。
status	String	ストリーミング統合ジョブのステータス。ジョブは、次のいずれかのステータスになります。デプロイ中。ジョブはデプロイ中です。稼働中。ジョブは実行中です。実行中（警告あり）。ジョブは実行中ですが警告があります。実行中（エラーあり）。ジョブは実行中ですがエラーがあります。アンデプロイ済み。ジョブはアンデプロイされています。停止。ジョブが意図的に停止されました。
extraData	String	タスクID、ストリーミング取り込みジョブの場所、Secure Agent IDなどの追加情報。

GET応答の例

使用可能な

ストリーミング統合

ジョブのリストを取得する要求が成功した場合、次の例のような応答を受け取ります。

{
    "@odata.context": "$metadata#Collection(OData.MI.JobMonitor.MIJob)",
    "@odata.count": 421,
    "value": [
        {
            "assetId": "7ce6bbc7-f0e2-4278-bd6d-d1187f4a1420",
            "assetName": "SIdeployJms",
            "assetType": "SI_DATAFLOW",
            "runId": 33015,
            "duration": 300000,
            "orgId": "1Pm6cSfPcAqfgeV57Fn3u4",
            "runtimeEnv": "011U5M08000000000003",
            "startTime": "2021-04-29T13:09:48.000+0000",
            "endTime": "2021-04-29T13:14:48.000+0000",
            "deployTime": "2021-04-29T13:09:48.000+0000",
            "undeployTime": "2021-04-29T13:14:48.000+0000",
            "startedBy": "siqa_new",
            "status": "Undeployed",
            "outOfSync": true,
            "extraData": "{\"taskId\":\"7Z4ZZjXc9QViT4t2okiHuz\",\"runtimeEnv\":\"011U5M25000000000002\",\"location\":\"RestAutomation\"}",
            "deployedVersion": 1,
            "replace": null,
            "lastUpdateTime": 0
        },
        {
            "assetId": "a03b9aa1-4a4a-47ee-808d-ddc0ee7b3a4a",
            "assetName": "kafka to kafka test",
            "assetType": "SI_DATAFLOW",
            "runId": 33527,
            "duration": 204988000,
            "orgId": "1Pm6cSfPcAqfgeV57Fn3u4",
            "runtimeEnv": "011U5M08000000000002",
            "startTime": "2021-05-04T05:41:39.000+0000",
            "endTime": "2021-05-06T14:38:07.000+0000",
            "deployTime": "2021-05-04T05:41:39.000+0000",
            "undeployTime": "2021-05-06T14:38:07.000+0000",
            "startedBy": "siqa_new",
            "status": "Undeployed",
            "outOfSync": true,
            "extraData": "{\"taskId\":\"8V21nib7Sqgiw3QoDRi5uK\",\"runtimeEnv\":\"011U5M25000000000002\",\"location\":\"Default\"}",
            "deployedVersion": 1,
            "replace": null,
            "lastUpdateTime": 0
        }
    ]
}

一括取り込みストリーミングREST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal