調用ModifyFlowJob接口,修改數據開發作業。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String ModifyFlowJob

系統規定參數。取值:ModifyFlowJob

RegionId String cn-hangzhou

地域ID。

ProjectId String FP-3535FE0BE5228***

項目ID。您可以調用ListFlowProjects查看項目的ID。

Id String FJ-1A2FB31D8295****

需要修改的作業的ID。您可以調用ListFlowJobs查看ID。

Name String my_updated_job_name

修改后的作業名稱。

Description String 這是一個修改后的作業描述

修改后的作業描述。

FailAct String CONTINUE

失敗策略,可能的取值:CONTINUE(提過本次作業),STOP(停止作業)

RetryPolicy String

重試策略,保留參數。

Params String oss://bucket_name/jar_to_run.jar

作業內容。如果是spark作業,該參數的內容會作為spark-submit的參數。

ParamConf String {"date":"${yyyy-MM-dd}"}

參數設置。

CustomVariables String {\"scope\":\"PROJECT\",\"entityId\":\"FP-80C2FDDBF35D9CC5\",\"variables\":[{\"name\":\"v1\",\"value\":\"1\",\"properties\":{\"password\":true}}]}

自定義變量。

EnvConf String {"key":"value"}

環境變量設置。

KnoxUser String my_knox_user_name

Knox的用戶名,執行Zeppelin Notebook時必須提供。

KnoxPassword String my_knox_password

Knox的用戶密碼,執行Zeppelin Notebook時必須提供。

RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

運行配置,取值如下:priority(優先級),userName(任務的Linux提交用戶),memory(內存,單位為MB),cores(核數)

MonitorConf String {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}

監控配置,僅SPARK_STREAMING類型作業支持監控配置。

Mode String YARN

模型模式,取值如下: YARN:將作業包裝成一個Launcher提交至YARN中執行,LOCAL:作業直接在機器上以進程方式運行。

ClusterId String C-A23BD131A862****

集群ID。您可以調用ListClusters查看集群的ID。

AlertConf String

保留參數。

ResourceList.N.Path String

保留參數。

ResourceList.N.Alias String

保留參數。

返回數據

名稱 類型 示例值 描述
Data Boolean true

API調用結果:true(修改成功),false(修改失敗)

RequestId String 1549175a-6d14-4c8a-89f9-5e28300f6d7e

請求ID。

示例

請求示例

http(s)://[Endpoint]/?Action=ModifyFlowJob
&RegionId=cn-hangzhou
&ProjectId=FP-3535FE0BE5228***
&Id=FJ-1A2FB31D8295****
&Name=my_updated_job_name
&Description=這是一個修改后的作業描述
&FailAct=CONTINUE
&Params=oss://bucket_name/jar_to_run.jar
&ParamConf={"date":"${yyyy-MM-dd}"}
&CustomVariables={\"scope\":\"PROJECT\",\"entityId\":\"FP-80C2FDDBF35D9CC5\",\"variables\":[{\"name\":\"v1\",\"value\":\"1\",\"properties\":{\"password\":true}}]}
&EnvConf={"key":"value"}
&KnoxUser=my_knox_user_name
&KnoxPassword=my_knox_password
&RunConf={"priority":1,"userName":"hadoop","memory":2048,"cores":1}
&MonitorConf={"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}
&Mode=YARN
&ClusterId=C-A23BD131A862****
&公共請求參數

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyFlowJobResponse>
    <Data>true</Data>
    <RequestId>1549175a-6d14-4c8a-89f9-5e28300f6d7e</RequestId>
</ModifyFlowJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : true,
  "RequestId" : "1549175a-6d14-4c8a-89f9-5e28300f6d7e"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

訪問錯誤中心查看更多錯誤碼。