ジョブログファイル
完了したデータ統合ジョブのログ情報を、オペレーションインサイトから要求できます。
オペレーションインサイトからログエントリを取得するには、次のリソースを使用します。
- •Login。Informatica Intelligent Cloud Servicesにログインし、ジョブログREST API呼び出しで使用するセッションIDを取得するために使用します。
- •jobLogEntries.完了したデータ統合ジョブのログ情報を要求するために使用します。
これらのリソースを使用するときには、次のルールに注意してください。
- •JSON形式を使用する。
- •次のURLを使用します。
<serverUrl>/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/<API name>
- •次の要求ヘッダー形式を使用します。
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>
サーバーのURLには、組織が使用するPODの名前とリージョン、およびInformatica Intelligent Cloud Servicesドメインのinformaticacloud.comが含まれます。組織のPODの名前とリージョンがわからない場合は、ユーザーインタフェースを使用してInformatica Intelligent Cloud Servicesにログインすると、組織のPODの名前とリージョンを確認することができます。POD情報は、ブラウザのアドレスバーにあります。
次の例では、https://usw3.dm-us.informaticacloud.comがサーバーのURLです。
https://usw3.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/home
サーバーURLをREST API呼び出しのヘッダーのベースURLとして使用します。
注: HTTPバージョンを自動的に含めるPostmanなどのツールを使用する場合は、URLにHTTPのバージョンを入力しないようにしてください。HTTPバージョンがURLに2回出現すると、要求が失敗します。
ログインしています
呼び出しのヘッダーにIDS-SESSION-IDを必要とするリソースを使用する場合に、このリソースを使用してInformatica Intelligent Cloud Servicesにログインします。正常なログイン応答には、IDS-SESSION-IDが含まれます。
POST要求
次のURLを使用します。
<login URL>/identity-service/api/v1/Login
ログインURLには、組織が所在するリージョンとInformatica Intelligent Cloud Servicesドメインのinformaticacloud.comが含まれます。Informatica Intelligent Cloud Servicesログインページを開くと、組織のログインリージョンを見つけることができます。リージョンのログインURLは、Informatica Intelligent Cloud Servicesにログインする前のブラウザのアドレスバーにあります。
次の例では、https://dm-us.informaticacloud.comがリージョンURLです。
https://dm-us.informaticacloud.com/identity-service/home
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
---|
username | String | ○ | Informatica Intelligent Cloud Servicesのユーザー名。 最大長は255文字です。 |
password | String | ○ | Informatica Intelligent Cloud Servicesのパスワード。 最大長は255文字です。 |
POST応答
要求が成功すると、ユーザーオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
後続の要求の応答で返されたセッションIDを使用します。
ユーザーオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
---|
sessionId | String | 現在のセッションのREST APIセッションID。最も正確なREST API要求ヘッダーに使用します。 |
sessionExpireTime | String | セッションが期限切れになる時間。 |
id | String | ユーザーID。 |
name | String | Informatica Intelligent Cloud Servicesのユーザー名。 |
currentOrgId | String | 現在の組織ID。 |
currentOrgName | String | 現在の組織の名前。 |
parentOrgId | String | 親組織のID。 |
orgId | String | ユーザーが属する組織のID。 |
orgName | String | ユーザーが属する組織の名前。 |
groups | String | ユーザーグループ。 |
effectiveRoles | String | ユーザーに割り当てられたロール。 |
effectivePrivileges | String | ユーザーに割り当てられた特権。 |
status | String | ユーザーのステータス。 |
timeZoneId | String | ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、 タイムゾーンのコードを参照してください。 |
authenticator | String | ユーザー認証方法。 |
ログ情報の取得
jobLogEntriesリソースを使用して、完了したデータ統合ジョブのログ情報をオペレーションインサイトから要求します。このリソースを使用する場合は、組織IDをURLに含めます。
GET要求
すべてのログの情報を要求するか、ログの応答をフィルタリングすることができます。過去33日間のデータを要求できます。応答は、適用されたフィルタに対して最大500件のレコードを返します。
ログからの情報を要求するには、次のURIを使用します。
/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries
ログ応答をフィルタリングするには、次のURIを使用します:
/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?<query parameters>
URIには次のようなフィルタを含めることができます:
パラメータ | タイプ | 説明 |
---|
filter | 文字列 | クエリフィルタ。 |
endTime | 日付 | タスクが終了した日付および時刻。 フィルタパラメータに含めます。 |
startswith | 文字列 | タスクを開始したランタイム環境、Secure Agent、またはアセット。 フィルタパラメータに含めます。 |
listfilter | 文字列 | ジョブのステータスとアセットタイプ。 |
status in | 文字列 | タスクのステータス。次のいずれかのステータスでフィルタリングすることができます。 - - COMPLETED
- - 注意(WARNING)
- - FAILED
- - END
- - SUCCESS
- - 停止
|
assetType in | 文字列 | アセットのタイプ: - - MTT。マッピングタスク。
- - TASKFLOW。高度なタスクフロー。
- - MI_TASK。一括取り込みタスク。
- - DSS。同期タスク。
- - WORKFLOW。リニアタスクフロー。
- - DRS。レプリケーションタスク。
- - PCS。PowerCenterタスク。
- - DTT.データ転送タスク。
- - DLT。データローダータスク。
- - MAPPING
- - BATCH_MAPPING。動的マッピングタスク。
- - DMASK。データマスキングタスク。
|
count | Int | trueの場合、適用されたフィルタで使用可能なレコードの合計を返します。 |
上 | Int | 返す要素の数。例えば、値が25である場合、適用されたフィルタで使用できる最初の25件のレコードが返されます。 最大値は500です。 |
skip | Int | スキップするレコード数。例えば、値を4に設定すると、リストの最初の4つのアセットが除外されます。 |
orderby | 文字列 | データを返すソート順序。 |
GET要求の例
次の例に、クエリパラメータを使用してログ情報を要求する方法を示します。
- •2023年10月8日午前6時から2023年10月9日午前6時の間に正常に完了したマッピングタスクのリストを要求するには、次のURIを使用します:
/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?$filter=(endTime%20ge%202023-10-08T06:00:00Z)%20and%20(endTime%20le%202023-10-09T06:00:00Z)&listFilter=status%20in%20(SUCCESS)%20and%20assetType%20in%20(MTT)&$count=true&$top=500&$skip=0
- •2023年10月1日午前6時から2023年10月31日午前6時の間に完了したすべてのジョブのリストを要求し、終了時刻の降順でジョブをソートするには、次のURIを使用します:
/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?$filter=(endTime%20ge%202023-10-01T06:00:00Z)%20and%20(endTime%20le%202023-11-31T06:00:00Z)&listFilter=status%20in%20(COMPLETED,WARNING,FAILED,END,SUCCESS,STOPPED)%20and%20assetType%20in%20(MTT,DTT,DMASK,PCS,DRS,DSS,MTT_TEST,BATCH_MAPPING,MAPPING,command,MI_TASK)&$count=true&$top=500&$skip=0&$oderby=endTime desc
GET応答
ログの各行に対してjobLogEntryオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
ログの各行に関する情報を要求した場合、jobLogEntryオブジェクトには次のような属性が含まれます。
フィールド | タイプ | 説明 |
---|
logEntryId | 文字列 | ログのエントリID。 |
assetId | 文字列 | タスクのID。 |
runId | 長整数型 | タスクの実行に必要なID。 |
assetName | 文字列 | アセットの名前。 |
instanceName | 文字列 | ジョブの名前を次の形式で指定します。 <asset name>-<instance number> |
orgId | 文字列 | 組織ID。 |
ステータス | 文字列 | ジョブが正常に完了したかどうかを示します。 |
assetType | 文字列 | タスクのタイプ。データ統合ジョブの場合は、次のいずれかのコードを返します。 - - MTT。マッピングタスク。
- - TASKFLOW。高度なタスクフロー。
- - MI_TASK。一括取り込みタスク。
- - DSS。同期タスク。
- - WORKFLOW。リニアタスクフロー。
- - DRS。レプリケーションタスク。
- - PCS。PowerCenterタスク。
- - DTT.データ転送タスク。
- - DLT。データローダータスク。
- - MAPPING。
- - BATCH_MAPPING。動的マッピングタスク。
- - DMASK。データマスキングタスク。
|
startTime | 日付/時刻 | タスクまたはリニアタスクフローの開始時刻。東部標準時(ET)を使用します。 |
endTime | 日付/時刻 | タスクまたはリニアタスクフローの終了時刻。東部標準時(ET)を使用します。 |
updateTime | 文字列 | タスクの最終更新時刻。 |
duration | ストリング | タスクが実行された時間(秒単位)。 |
errorMessage | String | ジョブに関連付けられているエラーメッセージ。 |
location | 文字列 | アセットの場所。 |
rowsProcessed | 文字列 | タスクによって処理された行の合計数。 |
successRows | 文字列 | タスクによって正常に処理された行の数。 |
errorRows | 文字列 | タスクによって処理されなかった行の数。 |
runtimeEnv | 文字列 | タスクを実行するランタイム環境。 |
runtimeEnvName | 文字列 | タスクが実行されているランタイム環境の名前。 |
startedBy | 文字列 | タスクを開始したユーザーまたはスケジュール。 |
サブタスク | 文字列 | タスクに含まれるサブタスクの数。 |
runContext | 文字列 | タスクの開始時に使用されたメソッド。次の値が含まれます。 - - UI。タスクがユーザーインタフェースを使用して開始されました。
- - SCHEDULER。タスクがタスクスケジューラを使用して開始されました。
- - REST API。タスクがREST APIを使用して開始されました。
- - OUTBOUND MESSAGE。タスクが送信メッセージを使用して開始されました。
|
extraData | 文字列 | saasLogIdやsaasTaskIdなどの追加情報。 |
parentEntityId | 文字列 | 親タスクのID。 |
updateDayHour | 日付/時刻 | タスクの最終更新時刻。 |
taskId | 文字列 | タスクのID。 |
stopOnError | Boolean | 致命的ではないエラーの発生時にランタイム環境でタスクを停止させるかどうかを示します。 |
isAtScale | Boolean | タスクに関連付けられたマッピングが詳細モードかどうかを示します。 |
parAssetName | 文字列 | 親アセットの名前。 |
parRunId | 文字列 | 親アセットの実行ID。 |
parLocation | 文字列 | 親アセットの場所。 |
parAssetType | 文字列 | 親アセットのタイプ。 |
agentId | 文字列 | タスクを実行しているSecure Agent。 |
agentName | 文字列 | タスクを実行しているエージェントの名前。 |
projectName | 文字列 | アセットが存在するプロジェクト。 |
GET応答の例
マッピングタスクのジョブログ情報を要求すると、次の応答が返されることがあります:
{
"@odata.context": "$metadata#JobLogEntries",
"@odata.count": 2,
"value": [
{
"logEntryId": "9hQOSzOu0GSeG0r73CzK8L",
"assetId": "jn94HPOUK4zlEoO07eGfEq",
"runId": "148201",
"assetName": "CDI_9102",
"instanceName": "CDI_9102-148201",
"orgId": "010cdi",
"status": "COMPLETED",
"assetType": "MTT",
"correlationId": "ZGVmN2E3ZDEtMTE2MC00NT",
"startTime": "2023-07-20T07:55:52Z",
"endTime": "2023-07-20T07:56:09Z",
"updateTime": null,
"duration": 17,
"errorMessage": "",
"location": "9102",
"rowsProcessed": 2,
"successRows": 2,
"errorRows": 0,
"runtimeEnv": "runtime environment",
"runtimeEnvName": "ASH0001",
"startedBy": "every_day",
"subtasks": 0,
"runContext": "SCHEDULER",
"extraData": "{\"saasLogId\":\"010AXYC100000000RC5Q\", \"runtimeType\":\"\", \"isServerless\":\"false\", \"releaseVersion\":\"4400\", \"saasTaskId\":\"010AXY0Z0000000005EM\"}",
"parentEntityId": null,
"statusDisplayName": "SUCCESS",
"updateDayHour": "2023-07-20T07:00:00Z",
"taskId": "010AXY0Z0000000005EM",
"stopOnError": "0",
"requestId": null,
"isAtScale": 0,
"parAssetName": null,
"parRunId": null,
"parLocation": "n/a",
"parAssetType": null,
"agentId": "010AXY08000000000003",
"agentName": "ASH0001",
"projectName": "9102"
}
{
"logEntryId": "7gQRt15YPsBcdK6RsozzSJ",
"assetId": "iwm48QrytmidcBrdpMElu6",
"runId": "145708",
"assetName": "CDI-9845_test2",
"instanceName": "CDI-9845_test2-145708",
"orgId": "010cdi",
"status": "COMPLETED",
"assetType": "MTT",
"correlationId": "NjNlNGFhY2QtYzFjZC00MT",
"startTime": "2023-07-20T07:55:52Z",
"endTime": "2023-07-20T07:56:03Z",
"updateTime": null,
"duration": 11,
"errorMessage": "",
"location": "Default",
"rowsProcessed": 1000,
"successRows": 1000,
"errorRows": 0,
"runtimeEnv": "runtime environment",
"runtimeEnvName": "ASH0001",
"startedBy": "CDI-9845_scheduler",
"subtasks": 0,
"runContext": "SCHEDULER",
"extraData": "{\"saasLogId\":\"010AXYC100000000RC5P\", \"runtimeType\":\"\", \"isServerless\":\"false\", \"releaseVersion\":\"4400\", \"saasTaskId\":\"010AXY0Z0000000005N4\"}",
"parentEntityId": null,
"statusDisplayName": "SUCCESS",
"updateDayHour": "2023-07-20T07:00:00Z",
"taskId": "010AXY0Z0000000005N4",
"stopOnError": "0",
"requestId": null,
"isAtScale": 0,
"parAssetName": null,
"parRunId": null,
"parLocation": "n/a",
"parAssetType": null,
"agentId": "agentID",
"agentName": "ASH0001",
"projectName": "Default"
}