DataStudio で UpdateWorkflowDefinition API を呼び出す - DataWorks

操作説明

重要このインターフェースはバッチ操作をサポートしていません。FlowSpec で複数のワークフローが定義されている場合、最初のワークフローを除き、後続のワークフローはすべて無視されます。また、ワークフロー内部で定義されたノードも直接無視されます。内部ノードを順次更新するには、UpdateNode インターフェースを呼び出してください。

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペース ID。DataWorks コンソールにログインし、ワークスペースページで ID をクエリできます。	10001
Id	string	必須	DataStudio ワークフローの一意の識別子。説明このフィールドは、SDK バージョン 8.0.0 より前では Long 型であり、SDK バージョン 8.0.0 以降では String 型です。この変更は通常の SDK 使用には影響しません。パラメーターは SDK で定義された型に従って返されます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりコンパイルエラーが発生する可能性があります。この場合、データの型を手動で更新する必要があります。	652567824470354XXXX
Spec	string	必須	DataStudio ワークフローの一意の識別子。説明 SDK バージョン 8.0.0 より前では、このフィールドは Long 型です。SDK バージョン 8.0.0 以降では、String 型です。この変更は通常の SDK の使用には影響しません。パラメーターは SDK で定義された型に基づいて返されます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりコンパイルエラーが発生する可能性があります。この場合、データの型を手動で更新する必要があります。	{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "workflows": [ { "id": "652567824470354XXXX", "script": { "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo", "runtime": { "command": "WORKFLOW" } }, "trigger": { "type": "Scheduler", "cron": "00 02 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "OpenAPI_Test_Workflow_Demo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo" } ] }, "dependencies": [] } ] } }

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。この ID に基づいてログを特定し、問題をトラブルシューティングできます。	20BF7E80-668A-5620-8AD8-879B8FEA****
Success	boolean	リクエストが成功したかどうかを示します。有効な値: true false	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "20BF7E80-668A-5620-8AD8-879B8FEA****",
  "Success": true
}

エラーコード

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

変更履歴

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