Cloud Integration Hub

前へ次へ

イベントREST API応答

のイベントAPIを使用してパブリケーションイベントまたはサブスクリプションイベントの詳細を取得すると、APIは次のイベント応答を返します。

以下に、イベントの詳細を照会する要求に対する応答の構文を示します。

応答ヘッダー: イベントREST API応答には次のヘッダーが含まれます。

Retry-After - <time in seconds>

Retry-After

は、フォローアップ要求を行う前に待機する時間（秒単位）です。

Retry-After

は、応答コードが

TOO_MANY_REQUESTS

である場合に表示されます。

応答本文: イベントREST API応答には次の本文が含まれます。

{
	"eventId": "Long",
	"eventType": "String",
	"applicationName": "String",
	"topicName": "String",
	"pubSubName": "String",
	"createTime": "Event StartTime :: Date",
	"completionTime": "Event Completed Time :: Date",
	"parentEventId": "Long",
	"descendantState": "enum mentioned in the request body.",
	"childEvents": "List<EventDetailResponse>",
	"runID": "String",
	"eventHistory": {
		"eventId": "Long",
		"timeStamp": "Date",
		"eventStatusName": "String",
		"comments": "String"
	}
}

次の表に、応答の要素を示します。

プロパティ	説明
eventId	Cloud Integration Hub が生成するパブリケーションイベントまたはサブスクリプションイベントのID。
eventType	Cloud Integration Hub が生成するパブリケーションイベントまたはサブスクリプションイベントのタイプ。
applicationName	パブリケーションまたはサブスクリプションに関連付けられたアプリケーションの名前。
topicName	パブリケーションまたはサブスクリプションに関連付けられたトピックの名前。
pubSubName	パブリケーションまたはサブスクリプションの名前。
createTime	Cloud Integration Hub がパブリケーションイベントまたはサブスクリプションイベントを作成した時間。
completionTime	パブリケーションイベントまたはサブスクリプションイベントの終了時間。
eventStatus	パブリケーションイベントまたはサブスクリプションイベントのステータス。
parentEventId	プロファイルIDに基づいて子イベントを作成し、子イベントのイベントIDを返します。
descendantState	すべての子イベントの累積ステータス。
childEvents	親イベント内で使用可能なイベント。パブリケーションイベントに適用されます。
eventHistory	完全なイベントプロセスの詳細。次のような構文がeventHistory応答に表示されます。 { "eventId": "Long", "timeStamp": "Date", "eventStatusName": "String", "comments": "String" }
sourceSuccessCount	Cloud Integration Hub が正常に読み取ったソース行またはソースファイルの数。
sourceFailedCount	Cloud Integration Hub が読み取りに失敗したソース行またはソースファイルの数。
targetSuccessCount	Cloud Integration Hub が正常に書き込んだターゲット行またはソースファイルの数。
targetFailedCount	Cloud Integration Hub が書き込みに失敗したターゲット行またはターゲットファイルの数。
runId	関連するデータ統合タスクまたはファイル一括取り込みタスクの実行ID。

応答コード: Cloud Integration Hub
のイベントAPIを使用して既存イベントの詳細を取得すると、
Cloud Integration Hub
では、APIの応答に、実行したアクションの応答コードが返されます。

このAPIから返される応答コードは次のとおりです。

コード
説明

200
SUCCESS。要求が成功しました。

429
TOO_MANY_REQUESTS。失敗した要求の数が組織の許容制限を超えました。

コード	説明
200	SUCCESS。要求が成功しました。
429	TOO_MANY_REQUESTS。失敗した要求の数が組織の許容制限を超えました。

例:

{
	"eventId": 32010,
	"createTime": "2023-04-20T02:45:58.094Z",
	"completionTime": "2023-04-20T02:46:40.130Z",
	"eventType": "PUBLICATION",
	"eventStatus": "Complete",
	"descendantState": "ERROR",
	"applicationName": "DI_App",
	"pubSubName": "DSS_Pub",
	"topicName": "DI_Topic",
	"sourceSuccessCount": 1,
	"sourceFailedCount": 0,
	"targetSuccessCount": 1,
	"targetFailedCount": 0,
	"runId": "28",
	"childEvents": [
		{
			"eventId": 32011,
			"createTime": "2023-04-20T02:46:40.157Z",
			"completionTime": "2023-04-20T02:47:04.801Z",
			"parentEventId": 32010,
			"eventType": "SUBSCRIPTION",
			"eventStatus": "Error",
			"descendantState": "NONE",
			"applicationName": "DI_App",
			"pubSubName": "DSS_Sub",
			"topicName": "DI_Topic",
			"sourceSuccessCount": 0,
			"sourceFailedCount": 0,
			"targetSuccessCount": 0,
			"targetFailedCount": 0,
			"runId": "9",
			"eventHistory": [
				{
					"eventId": 32011,
					"timeStamp": "2023-04-20T02:46:40.158Z",
					"eventStatusName": "Processing",
					"comments": ""
				},
				{
					"eventId": 32011,
					"timeStamp": "2023-04-20T02:47:04.801Z",
					"eventStatusName": "Error",
					"comments": "Subscription to topic failed. The job failed."
				}
			]
		}
	],
	"eventHistory": [
		{
			"eventId": 32010,
			"timeStamp": "2023-04-20T02:45:58.095Z",
			"eventStatusName": "Processing",
			"comments": ""
		},
		{
			"eventId": 32010,
			"timeStamp": "2023-04-20T02:46:40.130Z",
			"eventStatusName": "Complete",
			"comments": "Publishing to topic completed successfully"
		}
	]
}

イベントREST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal