すべてのプロダクト
Search

このプロダクト

    :UpdateProcessDefinitionWithSchedule

    ドキュメントセンター

    :UpdateProcessDefinitionWithSchedule

    最終更新日:Nov 25, 2025

    ワークフロー定義とその時間指定スケジューリングを更新します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    emr-serverless-spark:UpdateProcessDefinitionWithSchedule

    none

    *All Resource

    *

    		 なし なし

    リクエスト構文

    PUT /dolphinscheduler/projects/{bizId}/process-definition/{code} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    bizId

    string

    必須

    ワークスペース ID。

    w-d8********

    code

    integer

    必須

    ワークフロー定義 ID。

    12************

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    productNamespace

    string

    必須

    プロダクトコード。

    SS
    name

    string

    必須

    ワークフロー名。

    ods_batch_workflow

    description

    string

    任意

    ワークフローの説明。

    ods batch workflow
    timeout

    integer

    任意

    ワークフロー実行のデフォルトのタイムアウト期間。

    300
    taskDefinitionJson

    array<object>

    必須

    タスク定義の JSON 配列。この配列には、ワークフロー内のすべてのタスクの記述情報が含まれます。

    array<object>

    必須

    タスク定義の JSON オブジェクト。このオブジェクトには、ワークフロー内のタスクの記述情報が含まれます。

    code

    integer

    必須

    タスク定義 ID。

    23************
    description

    string

    任意

    タスク定義の説明。

    ods transform task

    alertEmailAddress

    string

    任意

    アラート用のメールアドレス。

    foo_bar@spark.alert.invalid.com

    startAlertEnable

    boolean

    任意

    タスク開始時にアラートを有効にするかどうかを指定します。

    true
    failAlertEnable

    boolean

    任意

    タスクが失敗したときにアラートを有効にするかどうかを指定します。

    true
    failRetryTimes

    integer

    任意

    タスクが失敗した場合にリトライする回数。

    1
    name

    string

    必須

    タスク名。

    ods_transform_task

    taskParams

    object

    必須

    タスク定義のパラメーター。

    workspaceBizId

    string

    必須

    ワークスペース ID。

    w-d8********

    taskBizId

    string

    必須

    データ開発タスクの ID。

    TSK-d87******************

    resourceQueueId

    string

    必須

    タスクが実行されるキューの名前。

    root_queue
    sparkDriverCores

    integer

    任意

    Spark ドライバーのコア数。

    1
    sparkExecutorCores

    integer

    任意

    各 Spark エグゼキュータのコア数。

    1
    sparkDriverMemory

    integer

    任意

    Spark ドライバーのメモリサイズ。

    4g
    sparkExecutorMemory

    integer

    任意

    各 Spark エグゼキュータのメモリサイズ。

    4g
    sparkConf

    array<object>

    任意

    Spark タスクの構成。

    object

    任意

    Spark タスクの構成。

    key

    string

    任意

    Spark 構成のキー。

    spark.dynamicAllocation.enabled

    value

    string

    任意

    Spark 構成の値。

    true
    sparkVersion

    string

    任意

    Spark エンジンのバージョン。

    esr-4.0.0 (Spark 3.5.2, Scala 2.12)

    sparkLogLevel

    string

    任意

    Spark のログレベル。

    INFO
    sparkLogPath

    string

    任意

    Spark タスクのログを保存するパス。

    oss://data***/spark/logs

    displaySparkVersion

    string

    任意

    Spark エンジンの表示バージョン。

    esr-4.0.0 (Spark 3.5.2, Scala 2.12)
    fusion

    boolean

    任意

    Fusion エンジンを有効にして高速化するかどうかを指定します。

    false
    environmentId

    string

    任意

    環境 ID。

    ev-h*************
    type

    string

    任意

    Spark ジョブのタイプ。

    SQL
    localParams

    array<object>

    任意

    object

    任意

    prop

    string

    任意

    direct

    string

    任意

    type

    string

    任意

    value

    string

    任意

    taskType

    string

    必須

    ワークフローノードのタイプ。

    EMR-SERVERLESS-SPARK
    timeout

    integer

    任意

    タスク実行のデフォルトのタイムアウト期間。

    30
    tags

    object

    任意

    タグ。

    string

    任意

    タグのキーと値のペアの JSON 文字列。

    “{\"tagkey\":\"tagvalue\"}”

    taskRelationJson

    array<object>

    必須

    ワークフロー内のタスク間の依存関係を定義する JSON 配列。`preTaskCode` は上流タスク ID を指定し、`postTaskCode` は下流タスク ID を指定します。各タスクには一意の ID が必要です。上流タスクのないタスクノードの場合は、依存関係を追加し、`preTaskCode` を 0 に設定します。

    object

    必須

    タスクの依存関係を定義する JSON オブジェクト。`preTaskCode` は上流タスク ID を指定し、`postTaskCode` は下流タスク ID を指定します。各タスクには一意の ID が必要です。上流タスクのないタスクノードの場合は、依存関係を追加し、`preTaskCode` を 0 に設定します。

    name

    string

    必須

    タスクトポロジーの名前。ワークフロー名を使用できます。

    ods batch workflow

    preTaskCode

    integer

    必須

    上流タスク ID。

    16************

    preTaskVersion

    integer

    必須

    上流タスクのバージョン。

    1
    postTaskCode

    integer

    必須

    下流タスク ID。

    19************

    postTaskVersion

    integer

    必須

    下流タスクのバージョン。

    1
    executionType

    string

    必須

    実行ポリシー。

    PARALLEL
    alertEmailAddress

    string

    任意

    アラート用のメールアドレス。

    foo_bar@spark.alert.invalid.com
    schedule

    object

    任意

    スケジューリング構成。

    startTime

    string

    任意

    開始時刻。

    2024-12-23 16:13:27

    endTime

    string

    任意

    スケジュールの終了時刻。

    2025-12-23 16:13:27

    crontab

    string

    任意

    スケジューリング用の cron 式。

    0 0 0 * * ?

    timezoneId

    string

    任意

    タイムゾーン ID。

    Asia/Shanghai

    retryTimes

    integer

    任意

    リトライ回数。

    1
    taskParallelism

    integer

    任意

    ワークフローノードの同時実行の度合い。

    1
    tags

    object

    任意

    タグ。

    string

    任意

    タグのキーと値のペアの JSON 文字列。

    “{\"tagkey\":\"tagvalue\"}”

    resourceQueue

    string

    任意

    リソースキュー。

    root_queue
    releaseState

    string

    任意

    ワークフローのリリース状態。

    ONLINE
    runAs

    string

    任意

    ワークフローを実行するユーザー。

    113***************

    publish

    boolean

    任意

    ワークフローを公開するかどうかを指定します。

    true
    regionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    globalParams

    array<object>

    任意

    object

    任意

    prop

    string

    任意

    value

    string

    任意

    direct

    string

    任意

    type

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    requestId

    string

    リクエスト ID。

    DD6B1B2A-5837-5237-ABE4-FF0C8944****
    code

    integer

    バックエンド API からのリターンコード。

    1400009
    msg

    string

    リターンコードに対応する詳細な説明。

    No permission for resource action
    success

    string

    リクエストが成功したかどうかを示します。

    true
    failed

    string

    失敗した操作の数。

    false
    data

    object

    返されたデータ。

    id

    string

    ワークフロー定義番号。

    123223
    code

    string

    ワークフロー定義 ID。

    12***********
    name

    string

    ワークフロー定義の名前。

    ods_batch_workflow
    version

    integer

    バージョン番号。

    1
    releaseState

    string

    ワークフローのリリース状態。

    ONLINE
    bizId

    string

    ワークスペース ID。

    alicloud_ack_one_cluster
    description

    string

    ワークフロー定義の説明。

    1
    createTime

    string

    ワークフロー定義が作成された時刻。

    2024-09-05T02:03:19Z
    updateTime

    string

    ワークフロー定義が更新された時刻。

    2024-03-05T06:24:27Z
    userId

    string

    ワークフローをスケジュールしたユーザーの ID。

    113*********
    userName

    string

    ワークフローをスケジュールしたユーザーの名前。

    w-********
    projectName

    string

    ワークフローが属するプロジェクトの名前。

    w-********
    executionType

    string

    実行ポリシー。

    SERIAL
    alertEmailAddress

    string

    アラート用のメールアドレス。

    foo_bar@spark.alert.invalid.com

    startTime

    string

    スケジュールの開始時刻。

    0
    endTime

    string

    スケジュールの終了時刻。

    1710432000000
    timezoneId

    string

    タイムゾーン ID。

    Asia/Shanghai

    crontab

    string

    スケジューリング用の cron 式。

    0 0 0 * * ?

    versionHashCode

    string

    バージョンのハッシュコード。

    dwerf*********
    httpStatusCode

    integer

    HTTP ステータスコード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "code": 1400009,
  "msg": "No permission for resource action",
  "success": "true",
  "failed": "false",
  "data": {
    "id": "123223",
    "code": "12***********",
    "name": "ods_batch_workflow",
    "version": 1,
    "releaseState": "ONLINE",
    "bizId": "alicloud_ack_one_cluster",
    "description": "1",
    "createTime": "2024-09-05T02:03:19Z",
    "updateTime": "2024-03-05T06:24:27Z",
    "userId": "113*********",
    "userName": "w-********",
    "projectName": "w-********",
    "executionType": "SERIAL",
    "alertEmailAddress": "foo_bar@spark.alert.invalid.com\n",
    "startTime": "0",
    "endTime": "1710432000000",
    "timezoneId": "Asia/Shanghai\n",
    "crontab": "0 0 0 * * ?\n",
    "versionHashCode": "dwerf*********"
  },
  "httpStatusCode": 200
}

    エラーコード

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

    変更履歴

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