CreateDISyncTask を使用したデータ同期タスクの作成 - DataWorks

操作説明

この操作を呼び出してタスクのスケジューリングプロパティを設定することはできません。タスクのスケジューリングプロパティを設定する場合は、操作を呼び出してください。

今すぐお試しください

この 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 を照会できます。	10000
TaskType	string	必須	データ同期タスクのタイプです。有効な値は、DI_OFFLINE、DI_REALTIME、DI_SOLUTION です。	DI_OFFLINE
TaskContent	string	必須	データ同期タスクのスクリプト内容です。	{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_source","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}
TaskParam	string	任意	データ同期タスクの構成パラメーターです。以下のパラメーターがサポートされています： FileFolderPath：データ同期タスクのストレージパス。 ResourceGroup：データ同期タスクで使用される Data Integration のリソースグループの識別子。リソースグループの識別子を照会するには、ListResourceGroups 操作を呼び出してください。 Cu：サーバーレスリソースグループ内でデータ同期タスクが占有する仕様。このパラメーターの値は 0.5 の倍数である必要があります。	{"FileFolderPath":"Business Flow/XXX/Data Integration","ResourceGroup":"S_res_group_XXX_XXXX"}
TaskName	string	任意	データ同期タスクの名前です。	new_di_task
ClientToken	string	任意	リクエストのべき等性を保証するためのクライアントトークンです。このパラメーターは空欄のままにできます。	0000-ABCD-EFG****

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。	true
RequestId	string	リクエスト ID です。	0bc1411515937635973****
Data	object	データ同期タスクが作成されたかどうかを示す情報です。
Status	string	データ同期タスクの作成ステータスです。有効な値は以下のとおりです： success fail	success
Message	string	データ同期タスクの作成に失敗した場合に返されるエラーメッセージです。データ同期タスクの作成に成功した場合は、このパラメーターは返されません。データ同期タスクの作成に失敗した場合、`Invalid path: Business Flow/xxxx/Data Integration` のような形式のエラーメッセージが返されます。	Invalid path: Business Flow/xxxx/Data Integration
FileId	integer	作成されたデータ同期タスクの ID です。	1000001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "不合法的目录路径：业务流程/xxxx/数据集成",
    "FileId": 1000001
  }
}

エラーコード

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.

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

変更履歴

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