すべてのプロダクト
Search
ドキュメントセンター

DataWorks:GetDISyncTask

最終更新日:Mar 21, 2026

リアルタイム同期タスクまたはデータ同期ソリューションの詳細をクエリします。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectId

integer

必須

DataWorks ワークスペースの ID です。DataWorks コンソール(https://workbench.data.aliyun.com/console)にログインし、[ワークスペース] ページに移動して、ワークスペース ID を確認できます。

このパラメーターを設定して、API オペレーションを適用する DataWorks ワークスペースを指定する必要があります。

10000

TaskType

string

必須

クエリ対象のオブジェクトの種類です。有効な値は以下のとおりです。

  • DI_REALTIME:リアルタイム同期タスク

  • DI_SOLUTION:データ同期ソリューション

DI_REALTIME

FileId

integer

必須

  • TaskType を DI_REALTIME に設定した場合、このパラメーターにはデプロイ対象のリアルタイム同期タスクの ID を指定します。

  • TaskType を DI_SOLUTION に設定した場合、このパラメーターにはデプロイ対象のデータ同期ソリューションの ID を指定します。

リアルタイム同期タスクまたはデータ同期ソリューションの ID は、ListFiles オペレーションを呼び出して取得できます。

100

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーターです。

Success

boolean

リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

  • True

  • False

true

RequestId

string

リクエスト ID です。この ID を使用してログを特定し、問題のトラブルシューティングを行います。

0bc1411515937635973****

Data

object

返された結果です。

Code

string

  • TaskType パラメーターが DI_REALTIME の場合、リアルタイム同期タスクの詳細が返されます。

  • TaskType パラメーターが DI_SOLUTION の場合、値 null が返されます。

{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}

Status

string

リアルタイム同期タスクまたはデータ同期ソリューションの詳細が取得できたかどうかを示します。有効な値は以下のとおりです。

success:詳細が取得できました。fail:詳細の取得に失敗しました。

success

Message

string

リアルタイム同期タスクまたはデータ同期ソリューションの詳細の取得に失敗した原因です。

リアルタイム同期タスクまたはデータ同期ソリューションの詳細が正常に取得できた場合は、値 null が返されます。

fileId:[100] is invalid.

AlarmList

array<object>

リアルタイム同期タスクに関連付けられたアラートルールです。このパラメーターの値は配列です。

array<object>

リアルタイム同期タスクに関連付けられたアラートルールです。

Id

integer

アラートルールの ID です。

45242

Enabled

boolean

アラートルールが有効化されているかどうかを示します。

true

RuleName

string

アラートルールの名前です。

Delay alert rule name 1

Metric

string

アラートの種類です。有効な値は以下のとおりです。

  • taskStatus

  • bizDelay

  • taskFailoverCount

  • ddlUnsupport

  • ddlReport

  • totalDirtyRecordWriteInLines

taskStatus

Description

string

アラートルールの説明です。

Description

AlarmRuleList

array<object>

アラート通知設定です。このパラメーターの値は配列です。

object

アラート通知設定です。

Level

string

  • WARNING

  • CRITICAL

WARNING

Comparator

string

比較演算子です。これは、メトリックとアラートルールを比較する方法を示します。

  • '='

  • '<'

  • '>'

=

Threshold

integer

メトリックとアラートルールの比較におけるしきい値です。

1

Duration

integer

アラートがトリガーされる前に条件が満たされる持続時間です。単位:分。

3

Aggregator

string

メトリックの計算方法です。有効な値は以下のとおりです。

  • avg

  • max

avg

NotifyRule

object

アラート通知ルールの設定です。このパラメーターの値は配列です。

Interval

integer

アラート間隔です。単位:分。

5

Warning

array

Warning レベルのアラート通知の設定です。

string

アラート通知方法です。有効な値は以下のとおりです。

  • Mail

  • Phone

  • Sms

  • Ding

Ding

Critical

array

Critical レベルのアラート通知の設定です。

string

アラート通知方法です。有効な値は以下のとおりです。

  • Mail

  • Phone

  • Sms

  • Ding

Ding

SolutionDetail

object

  • TaskType パラメーターが DI_REALTIME の場合、値 null が返されます。

  • TaskType パラメーターが DI_SOLUTION の場合、データ同期ソリューションの詳細が返されます。

Status

string

データ同期ソリューションのステータスです。有効な値は以下のとおりです。

  • 0:成功

  • 1:実行されていない

  • 2:実行中

  • 3:失敗

  • 4:コミット済み

  • 5:手動確認待ち

  • 6:手動で確認済み

  • 7:その他

  • 8:待機中

  • 9:削除済み

0

Type

string

データ同期ソリューションの種類です。

holo

StartTime

string

データ同期ソリューションの開始時刻です。

2021-12-07 14:40:51

CreatorName

string

データ同期ソリューションの作成者です。

dataworks_di

ProjectId

integer

データ同期ソリューションが属するプロジェクトの ID です。

10000

SourceType

string

データ同期ソリューションのソースの種類です。

mysql

ProcessContent

string

データ同期ソリューションの構成詳細です。

{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}

Name

string

データ同期ソリューションの名前です。

holo_20211206161025

ProcessExtra

string

データ同期ソリューションの追加パラメーターです。

{"processType":"new","tableNum":300}

SubmitTime

string

データ同期ソリューションがコミットされた時刻です。

2021-12-07 14:40:51

Id

integer

データ同期ソリューションの ID です。

100

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "0bc1411515937635973****\t",
  "Data": {
    "Code": "{\"extend\":{\"mode\":\"wizard\",\"resourceGroup\":\"S_res_group_287114642182658_1560324290517\"},\"nodeDef\":{},\"order\":{\"hops\":[{\"from\":\"datahub_8htXSsfiS2vtZCVG\",\"to\":\"datahub_CRHBAyGfhSaLmv2f\"}]},\"setting\":{\"errorLimit\":{},\"jvmOption\":\"\"},\"steps\":[{\"stepType\":\"datahub\",\"category\":\"writer\",\"displayName\":\"DataHub1\",\"parameter\":{\"batchSize\":1000,\"datasource\":\"datahub_cloud_dev_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt\"},\"name\":\"datahub_CRHBAyGfhSaLmv2f\",\"gui\":{\"x\":262,\"y\":325}},{\"stepType\":\"datahub\",\"displayName\":\"DataHub2\",\"parameter\":{\"datasource\":\"datahub_uric_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt_330000\",\"batchSize\":1000},\"name\":\"datahub_8htXSsfiS2vtZCVG\",\"gui\":{\"x\":268,\"y\":160.5},\"category\":\"writer\"}]}",
    "Status": "success",
    "Message": "fileId:[100] is invalid.",
    "AlarmList": [
      {
        "Id": 45242,
        "Enabled": true,
        "RuleName": "Delay alert rule name 1",
        "Metric": "taskStatus",
        "Description": "Description",
        "AlarmRuleList": [
          {
            "Level": "WARNING",
            "Comparator": "=",
            "Threshold": 1,
            "Duration": 3,
            "Aggregator": "avg"
          }
        ],
        "NotifyRule": {
          "Interval": 5,
          "Warning": [
            "Ding"
          ],
          "Critical": [
            "Ding"
          ]
        }
      }
    ],
    "SolutionDetail": {
      "Status": "0",
      "Type": "holo",
      "StartTime": "2021-12-07 14:40:51",
      "CreatorName": "dataworks_di",
      "ProjectId": 10000,
      "SourceType": "mysql",
      "ProcessContent": "{\"holoDatasource\":\"holo\",\"offlineSyncConfig\":{\"nodeNameRule\":\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\",\"resourceGroup\":\"group_219193793999490\"},\"processRuleId\":1007,\"readerConcurrent\":10,\"realtimeSyncConfig\":{\"content\":{\"order\":{\"hops\":[{\"from\":\"reader\",\"to\":\"writer\"}]},\"setting\":{\"speed\":{\"readerConcurrent\":10}},\"steps\":[{\"stepType\":\"mysql\",\"name\":\"reader\",\"category\":\"reader\",\"parameter\":{\"connection\":[{\"datasource\":\"mm\",\"datasourceType\":\"mysql\",\"table\":[]}]}},{\"stepType\":\"holo\",\"name\":\"writer\",\"category\":\"writer\",\"parameter\":{\"datasource\":\"holo\",\"writeMode\":\"replay\",\"datasourceSchema\":\"public\",\"tableMappingRule\":{\"datasource\":[{\"tableRule\":[],\"srcDatasourceName\":\"mm\"}]}}}]},\"extend\":{\"mode\":\"migration_holo\",\"resourceGroup\":\"group_219193793999490\"}},\"setting\":{\"autoCreateWorkflow\":true,\"userDefinedFileNameExpression\":\"oneclick\"},\"srcType\":\"mysql\",\"tableMappingRuleFromRealtimeSyncConfig\":{\"datasource\":[{\"srcDatasourceName\":\"mm\",\"tableRule\":[]}]}}",
      "Name": "holo_20211206161025",
      "ProcessExtra": "{\"processType\":\"new\",\"tableNum\":300}",
      "SubmitTime": "2021-12-07 14:40:51",
      "Id": 100
    }
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Param.Invalid The parameter is invalid.
500 InternalError.System An internal error occurred.
403 Forbidden.Access Access is forbidden.

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

変更履歴

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