すべてのプロダクト
Search

このプロダクト

    DataWorks:StartDISyncInstance

    ドキュメントセンター

    DataWorks:StartDISyncInstance

    最終更新日: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 コンソールにログインし、ワークスペースページでワークスペース ID を取得できます。この API オペレーションを適用する DataWorks ワークスペースを指定するには、このパラメーターを設定する必要があります。

    10000
    TaskType

    string

    必須

    開始するオブジェクトのタイプです。有効な値：

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

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

    DI_REALTIME
    FileId

    integer

    必須

    • TaskType を DI_REALTIME に設定した場合、このパラメーターを開始するリアルタイム同期タスクの ID に設定します。

    • TaskType を DI_SOLUTION に設定した場合、このパラメーターを開始するデータ同期ソリューションの ID に設定します。

    100
    StartParam

    string

    任意

    • TaskType を DI_REALTIME に設定した場合、StartParam パラメーターはリアルタイム同期タスクの起動パラメーターを指定します。起動パラメーターには、フェールオーバー関連のパラメーター、許可されるダーティデータレコード数を指定するパラメーター、およびデータ定義言語 (DDL) 文のパラメーターが含まれます。

    • TaskType を DI_SOLUTION に設定した場合、StartParam パラメーターは効果がありません。

    {"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true
    RequestId

    string

    リクエスト ID です。この ID に基づいてログの特定や問題のトラブルシューティングを行うことができます。

    0bc1411515937635973****
    Data

    object

    開始リクエストに対して返される結果です。

    Status

    string

    リアルタイム同期タスクまたはデータ同期ソリューションが開始されたかどうかを示します。有効な値：

    • success：リアルタイム同期タスクまたはデータ同期ソリューションが開始されました。

    • fail：リアルタイム同期タスクまたはデータ同期ソリューションの開始に失敗しました。提供された原因に基づいて問題をトラブルシューティングできます。

    success
    Message

    string

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

    リアルタイム同期タスクまたはデータ同期ソリューションが正常に開始された場合、null 値が返されます。

    fileId:[100] is invalid.

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "fileId:[100] is invalid."
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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