doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0085.html
Xiong, Chen Xiao f2733178cc DataArts API 20230329 version
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2023-06-29 16:21:21 +00:00

200 lines
8.3 KiB
HTML

<a name="dataartsstudio_02_0085"></a><a name="dataartsstudio_02_0085"></a>
<h1 class="topictitle1">Editing a Job</h1>
<div id="body0000001151374519"><div class="section" id="dataartsstudio_02_0085__en-us_topic_0181281354_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p1912913467404">This API is used to edit a job.</p>
</div>
<div class="section" id="dataartsstudio_02_0085__en-us_topic_0181281354_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0085__en-us_topic_0181281354_ul145591424184717"><li id="dataartsstudio_02_0085__en-us_topic_0181281354_li356152404715">URI format<p id="dataartsstudio_02_0085__en-us_topic_0181281354_p076674419427"><a name="dataartsstudio_02_0085__en-us_topic_0181281354_li356152404715"></a><a name="en-us_topic_0181281354_li356152404715"></a>PUT /v1/{project_id}/jobs/{job_name}</p>
</li></ul>
<ul id="dataartsstudio_02_0085__en-us_topic_0181281354_ul1370917277482"><li id="dataartsstudio_02_0085__en-us_topic_0181281354_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.67%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.04%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.989999999999998%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.67%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0085__en-us_topic_0181281354_row09056515229"><td class="cellrowborder" valign="top" width="19.67%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p19906125142215">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p890685112211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p590619542210">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p1906195152211">Job name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0085__en-us_topic_0181281354_section1041061122113"><h4 class="sectiontitle">Request</h4><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p8410171102112">See <a href="dataartsstudio_02_0084.html#dataartsstudio_02_0084__en-us_topic_0181281297_section10789431145710">Request</a>.</p>
</div>
<div class="section" id="dataartsstudio_02_0085__en-us_topic_0181281354_section04571028119"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0085__en-us_topic_0181281354_p1435121943013">Modify the properties of job <strong id="dataartsstudio_02_0085__en-us_topic_0181281354_b9771164251715">dliJob1</strong>.</p>
<ul id="dataartsstudio_02_0085__en-us_topic_0181281354_ul763675312599"><li id="dataartsstudio_02_0085__en-us_topic_0181281354_li1763615315598">Request<pre class="screen" id="dataartsstudio_02_0085__en-us_topic_0181281354_screen49871115389">PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/dliJob1
{
"logPath":"obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505",
"name":"dliJob1",
"nodes":[
{
"failPolicy":"FAIL",
"location":{
"x":"385.0",
"y":"150.0"
},
"maxExecutionTime":60,
"name":"DIS_INPUT",
"pollingInterval":1,
"preNodeName":[],
"properties":[
{
"name":"streamName",
"value":"csinput"
}
],
"resources":[],
"retryInterval":120,
"retryTimes":0,
"type":"DISStream"
},
{
"failPolicy":"FAIL",
"location":{
"x":"572.0",
"y":"151.0"
},
"maxExecutionTime":60,
"name":"CS_PROCESS",
"pollingInterval":10,
"preNodeName":[
"DIS_INPUT"
],
"properties":[
{
"name":"scriptName",
"value":"CS_PROCESS_TRIP"
},
{
"name":"jobName",
"value":"CS_PROCESS"
},
{
"name":"jobType",
"value":"flink_sql_job"
},
{
"name":"spuNumber",
"value":"2"
},
{
"name":"parallelNumber",
"value":"1"
}
],
"resources":[],
"retryInterval":120,
"retryTimes":0,
"type":"CSJob"
},
{
"failPolicy":"FAIL",
"location":{
"x":"718.0",
"y":"121.0"
},
"maxExecutionTime":60,
"name":"DIS_EVENT",
"pollingInterval":1,
"preNodeName":[
"CS_PROCESS"
],
"properties":[
{
"name":"streamName",
"value":"dis-event"
}
],
"resources":[],
"retryInterval":120,
"retryTimes":0,
"type":"DISStream"
},
{
"eventTrigger":{
"channel":"dis-event",
"concurrent":1,
"eventType:"DIS",
"readPolicy":"LAST"
},
"failPolicy":"FAIL",
"location":{
"x":"848.0",
"y":"167.0"
},
"maxExecutionTime":60,
"name":"TRIP_RAW_STANDARD",
"pollingInterval":10,
"preNodeName":[
"DIS_EVENT"
],
"properties":[
{
"name":"scriptName",
"value":"TRIP_RAW_STANDARD"
},
{
"name":"database",
"value":"lixinlong"
},
{
"name":"queueName",
"value":"default"
}
],
"resources":[],
"retryInterval":120,
"retryTimes":0,
"type":"DLISQL"
}
],
"params":[
{
"name":"dis_channel",
"value":"dis_input"
}
],
"processType":"REAL_TIME",
"resources":[],
"schedule":{
"type":"EXECUTE_ONCE"
},
"version":"1.0"
}</pre>
</li></ul>
<ul id="dataartsstudio_02_0085__en-us_topic_0181281354_ul3725916596"><li id="dataartsstudio_02_0085__en-us_topic_0181281354_li108313505615">Success response<p id="dataartsstudio_02_0085__en-us_topic_0181281354_p2186131670"><a name="dataartsstudio_02_0085__en-us_topic_0181281354_li108313505615"></a><a name="en-us_topic_0181281354_li108313505615"></a>HTTP status code 204</p>
</li><li id="dataartsstudio_02_0085__en-us_topic_0181281354_li313082312504">Failure response<p id="dataartsstudio_02_0085__en-us_topic_0181281354_p17868101111567"><a name="dataartsstudio_02_0085__en-us_topic_0181281354_li313082312504"></a><a name="en-us_topic_0181281354_li313082312504"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0085__en-us_topic_0181281354_screen2818105917308">{
"error_code":"DLF.0100",
"error_msg":"The job does not exists."
}</pre>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0083.html">APIs to Be Taken Offline</a></div>
</div>
</div>