ワークフローを変更する操作です。

デバッグ

Alibaba Cloud は、API を簡単に利用できる OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須項目 説明
Action String 必須 ModifyFlow

実行したい操作。 このパラメーターを ModifyFlow に設定します。

Id String 必須 F-7A39731FE719****

ワークフローの ID。

ProjectId String 必須 FP-3535FE0BE522 ****

プロジェクトの ID。

RegionId String 必須 cn-hangzhou

リージョンの ID。

AlertConf String 任意 {"items":[{"enable":true,"eventId":"EMR-210401001","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401015","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401002","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]}]}

アラート設定。 現在、eventId パラメーターには次の値があります。

  • EMR-210401001 : ワークフローが失敗したときに送信されるアラートを示します。
  • EMR-110401002 : ワークフローが成功したときに送信される通知を示します。
  • EMR-110401015 : ワークフローノードが失敗したときに送信されるアラートを示します。
AlertDingDingGroupBizId String 任意 Deprecated

非推奨のフィールド。

AlertUserGroupBizId String 任意 Deprecated

非推奨のフィールド。

Application String 任意 {"nodeDefMap":{":start:":{"name":":start:","type":":start:","transitions":["cluster"]},"cluster":{"id":"CT-0C74281682CF03B4","name":"cluster","type":":Cluster:","transitions":["job1"]},"job1":{"jobId":"FJ-242AB240DBAF4195","name":"job1","type":":action:","transitions":["end"]},"end":{"name":"end","type":":end:"}}}

nodeDefMap が表示するワークフローの構成情報。 nodeDefMap はノードのグループで構成されています。 ノードのタイプと遷移パラメーターは、次のとおりです。

  • type: ノードのタイプを示します。 有効値は、:start: (開始ノードを示す)、:Cluster: (オンデマンドクラスターを構築するためのノードを示す)、:action: (アクションノードを示す)、:end: (終了ノードを示す) です。
  • transitions: ノードの子孫ノードを示します。

ノードが複数ある場合は、カンマ (,) で区切ります。

ClusterId String 任意 C-F32FB31D8295 ****

クラスターの ID。

CreateCluster Boolean 任意 false

クラスターテンプレートを使用してクラスターを作成するかどうかを指定します。 このパラメーターを true に設定した場合、クラスターテンプレートを使用してクラスターを作成します。 この場合、ClusterId パラメーターをクラスターテンプレートの ID (CT-xxx ) に設定します。 このパラメーターを false に設定した場合、ClusterId パラメーターを既存のクラスターの ID (C-xxx) に設定します。

CronExpr String 任意 0 0 0-23/1 * * ?

定期的なスケジューリング設定に使用される Cron 式。 詳細については、『Cron 式』をご参照ください。

Description String 任意 my flow description

ワークフローの説明。 説明の長さは 最大 156 文字までです。

EndSchedule Long 任意 1542783967503

スケジュールの終了時間。 値は Long 型のタイムスタンプです。 System.currentTimeMillis() メソッドを実行して時間を取得できます。

HostName String 任意 emr-header-1.cluster-12345

ワークフローが実行されているホストの名前。 ホストは、マスターノードまたはゲートウェイノードにすることができます。 ホスト名の形式は emr-header-1.cluster-12345 です。 ホストにログインして、hostname コマンドを実行し、ホスト名を確認することができます。

Name String 任意 my_flow

ワークフローの名前。 名前は最大 64 文字で、プロジェクト内では固有である必要があります。

ParentCategory String 任意 FC-FC396F988E07C06F

親ディレクトリの ID。 このパラメーターが空白の場合、ルートディレクトリが使用されます。

ParentFlowList String 任意 F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89

ワークフローが依存する祖先ワークフローの ID リスト。 ID が複数ある場合は、カンマ (,) で区切ります。

Periodic Boolean 任意 true

定期的なスケジューリングを有効にするかどうかを指定します。

StartSchedule Long 任意 1542783867503

スケジュールの開始時間。 値は Long 型のタイムスタンプです。 System.currentTimeMillis() メソッドを実行して時間を取得できます。 このパラメーターは、次の要件を満たす必要があります。

  • このパラメーターの値は、EndSchedule パラメーターの値よりも小さくする必要があります。
  • CronExpr パラメーターを空白にしない場合、このパラメーターは必須項目です。
Status String 任意 UNDER_SCHEDULE

ワークフローのステータス。

レスポンスパラメーター

パラメーター データ型 説明
Data Boolean true

変更結果。 値は true の場合は、変更が成功したことを示します。 false の場合は、変更が失敗したことを示します。

RequestId String ECC2D0D1-B6D5-468D-B698-30E8805EB574

リクエストの ID です。

例 

リクエスト例


http(s)://[Endpoint]/? Action=ModifyFlow
&Id=F-7A39731FE719****
&ProjectId=FP-3535FE0BE522****
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<ModifyFlowResponse>
	  <RequestId>ECC2D0D1-B6D5-468D-B698-30E8805EB574</RequestId>
	  <Data>true</Data>
</ModifyFlowResponse>

JSON 形式

{
	"Data":true,
	"RequestId":"ECC2D0D1-B6D5-468D-B698-30E8805EB574"
}

エラーコード

エラーコードの詳細については、「API エラーセンター」をご参照ください。