リアルタイム同期タスクを非同期で更新するための構成生成 - DataWorks

操作説明

DataWorks では、現在、データ統合のオフライン同期タスクを更新する場合のみ、UpdateDISyncTask API オペレーションを直接使用できます。一方、データ統合のリアルタイム同期タスクを更新するには、まず GenerateDISyncTaskConfigForUpdating および QueryDISyncTaskConfigProcessResult API オペレーションを呼び出して、更新に必要なパラメーターを非同期で生成し、その後、そのパラメーターを UpdateDISyncTask API オペレーションの入力パラメーターとして指定して、対象のリアルタイム同期タスクを更新する必要があります。リアルタイム同期タスクの更新は、非同期方式でのみサポートされています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。DataWorks コンソール（https://dataworks.console.alibabacloud.com/console）にログインし、「ワークスペース」ページに移動することで、ワークスペース ID を確認できます。このパラメーターを設定して、API オペレーションを適用する DataWorks ワークスペースを指定する必要があります。	10000
TaskType	string	必須	非同期モードでデータ統合において更新対象とするオブジェクトの種類。有効な値は以下のとおりです。 DI_REALTIME：リアルタイム同期タスク DI_SOLUTION: 同期ソリューション DataWorks では、Data Integration でリアルタイム同期タスクを作成または更新できるのは、非同期モードのみです。 DataWorks では、データ統合におけるリアルタイム同期タスクの作成または更新は、非同期モードでのみ可能です。 DI_OFFLINE DI_REALTIME DI_SOLUTION	DI_REALTIME
TaskParam	string	必須	データ統合におけるリアルタイム同期タスクを更新するためのスクリプト。DataWorks では、データ統合におけるリアルタイム同期タスクのテーブル追加または削除は、非同期モードでのみ可能です。サポートされるリアルタイム同期タスクの種類は以下のとおりです。 MySQL から MaxCompute へのデータ同期タスク MySQL から Kafka へのデータ同期タスク MySQL から Hologres へのデータ同期タスク SelectedTables パラメーターは、複数のデータベースから同期するテーブルを指定するために使用します。Tables パラメーターは、単一のデータベースから同期するテーブルを指定するために使用します。スクリプトに SelectedTables パラメーターが含まれている場合、システムは SelectedTables パラメーターで指定されたテーブルからデータを同期します。スクリプトに Tables パラメーターが含まれている場合、システムは Tables パラメーターで指定されたテーブルからデータを同期します。	{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}
ClientToken	string	任意	リクエストのべき等性を保証するためのクライアントトークン。このパラメーターは、複数回の呼び出しによって重複した操作が発生することを防止するために使用されます。	ABFUOEUOTRTRJKE
TaskId	integer	必須	タスク ID。 TaskType パラメーターを DI_REALTIME に設定した場合、TaskId パラメーターには、リアルタイム同期タスクの FileId パラメーターの値を指定します。 TaskType パラメーターを DI_SOLUTION に設定した場合、TaskId パラメーターには、同期ソリューションの FileId パラメーターの値を指定します。	100

レスポンスフィールド

フィールド	型	説明	例
	object	応答結果。
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true false	true
RequestId	string	リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングを行えます。	0bc1411515937635973****
Data	object	非同期スレッドの ID に関する情報。
Status	string	非同期スレッドの ID が正常に生成されたかどうかを示します。有効な値は以下のとおりです。 success：非同期スレッドの ID が正常に生成されたことを示します。 fail：非同期スレッドの ID の生成に失敗したことを示します。失敗理由を確認し、それに基づいてトラブルシューティングを行ってください。	true
ProcessId	integer	非同期スレッドの ID。`QueryDISyncTaskConfigProcessResult` API オペレーションを呼び出す際にこの ID を指定すると、非同期で生成されたパラメーターを取得できます。取得したパラメーターは、Data Integration におけるリアルタイム同期タスクの更新に使用します。	10
Message	string	非同期スレッドの ID の生成に失敗した理由。ID が正常に生成された場合は、このパラメーターには値が返されません。	XXX is invalid.

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "true",
    "ProcessId": 10,
    "Message": "XXX is invalid."
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.DI.Parameter	The parameter is invalid.
400	Invalid.DI.Parameter.File.Existed	The file name already exists.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。