すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDISyncInstanceInfo

    ドキュメントセンター

    DataWorks:GetDISyncInstanceInfo

    最終更新日: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 に設定した場合、FileId パラメーターをクエリするリアルタイム同期タスクの ID に設定します。

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

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

    100

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    Success

    boolean

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

    • true

    • false

    true
    RequestId

    string

    リクエスト ID。

    0bc1411515937635973****
    Data

    object

    リアルタイム同期タスクまたはデータ同期ソリューションのステータス。

    Status

    string

    • TaskType パラメーターが DI_REALTIME に設定されている場合、Status パラメーターはリアルタイム同期タスクのステータスを示します。 有効な値: PAUSE、NORUN、RUN、KILLING、WAIT。

    • TaskType パラメーターが DI_SOLUTION に設定されている場合、Status パラメーターはデータ同期ソリューションのステータスを示します。 有効な値: success、fail。

    RUN
    Message

    string

    リアルタイム同期タスクまたはデータ同期ソリューションのステータス取得に失敗した場合の原因。ステータスが正常に取得された場合は、null が返されます。

    fileId[100] is invalid
    Name

    string

    • TaskType パラメーターが DI_REALTIME に設定されている場合、Name パラメーターはリアルタイム同期タスクの名前を示します。

    • TaskType パラメーターが DI_SOLUTION に設定されている場合、null が返されます。

    streamx_name
    SolutionInfo

    object

    • TaskType パラメーターが DI_REALTIME に設定されている場合、null が返されます。

    • TaskType パラメーターが DI_SOLUTION に設定されている場合、SolutionInfo パラメーターはデータ同期ソリューションの詳細を示します。

    Status

    string

    データ同期ソリューションのステータス。

    run
    Id

    integer

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

    100
    CreatorName

    string

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

    dataworks_3h1
    StepDetail

    array<object>

    データ同期ソリューションのステップ詳細。

    object

    返されるデータ。

    Status

    string

    データ同期ソリューションのステップのステータス。

    success
    StepId

    integer

    データ同期ソリューションのステップの ID。

    1
    StepName

    string

    データ同期ソリューションのステップの名前。

    Create a base table
    Info

    string

    データ同期ソリューションの情報。

    {\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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