ListDIJobs 呼び出しによる同期タスクのクエリ - DataWorks

新バージョンの同期タスクのリストを照会します。MySQL データベースから Hologres へのリアルタイムデータ同期がサポートされています。

操作説明

この操作を呼び出すことで、タスクの基本情報のみを取得できます。タスクの詳細を取得する場合は、GetDIJob 操作を呼び出してください。

今すぐお試しください

この 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:*

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	ワークスペースの ID です。	1967
JobName	string	任意	タスクの名前です。あいまい一致がサポートされています。このパラメーターを設定しない場合、タスクに制限は課されません。	mysql_to_holo_sync_8772
SourceDataSourceType	string	任意	ソースタイプです。このパラメーターを設定しない場合、タスクに制限は課されません。	MySQL
DestinationDataSourceType	string	任意	送信先タイプです。このパラメーターを設定しない場合、タスクに制限は課されません。	Hologres
PageNumber	integer	任意	ページ番号です。デフォルト値: 1。	1
PageSize	integer	任意	1ページあたりのエントリ数です。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果です。
RequestId	string	リクエスト ID です。	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
DIJobPaging	object	ページネーション情報です。
TotalCount	integer	返されたエントリの総数です。	6
PageNumber	integer	ページ番号です。	1
PageSize	integer	1ページあたりのエントリ数です。	10
DIJobs	array<object>	タスクのリストです。
	object
DIJobId	integer	タスク ID です。	16626
ProjectId	integer	ワークスペース ID です。	1967
JobName	string	タスク名です。	mysql_to_holo_sync_8772
MigrationType	string	同期タイプです。有効な値: FullAndRealtimeIncremental: 1回限りのフル同期とリアルタイム増分同期 RealtimeIncremental: リアルタイム増分同期 Full: フル同期列挙値: FullAndRealtimeIncremental : RealtimeIncremental : Full :	Full
SourceDataSourceType	string	ソースのタイプです。値は MySQL が返されます。列挙値: MySQL : MySQL	MySQL
DestinationDataSourceType	string	送信先のタイプです。値は Hologres が返されます。列挙値: Hologres : Hologres	Hologres
JobStatus	string	タスクステータスです。有効な値: Finished Initialized Stopped Failed Running Stopping 列挙値: Finished : Initialized : Stopped : Failed : Running : Stopping :	Finished

例

成功レスポンス

JSONJSON

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "DIJobPaging": {
    "TotalCount": 6,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobs": [
      {
        "DIJobId": 16626,
        "ProjectId": 1967,
        "JobName": "mysql_to_holo_sync_8772",
        "MigrationType": "Full",
        "SourceDataSourceType": "MySQL",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Finished"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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