doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0087.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

217 lines
11 KiB
HTML

<a name="dataartsstudio_02_0087"></a><a name="dataartsstudio_02_0087"></a>
<h1 class="topictitle1">Viewing Job Details</h1>
<div id="body0000001151174585"><div class="section" id="dataartsstudio_02_0087__en-us_topic_0181281311_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p1912913467404">This API is used to view job details.</p>
</div>
<div class="section" id="dataartsstudio_02_0087__en-us_topic_0181281311_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0087__en-us_topic_0181281311_ul145591424184717"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_li356152404715">URI format<p id="dataartsstudio_02_0087__en-us_topic_0181281311_p076674419427"><a name="dataartsstudio_02_0087__en-us_topic_0181281311_li356152404715"></a><a name="en-us_topic_0181281311_li356152404715"></a>GET /v1/{project_id}/jobs/{name}</p>
</li></ul>
<ul id="dataartsstudio_02_0087__en-us_topic_0181281311_ul44785462213"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_li447155416223">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.79%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.92%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_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_0087__en-us_topic_0181281311_row1692125192313"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p199210512316">name</p>
</td>
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p149295172316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p129245172319">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p1392165112319">Job name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0087__en-us_topic_0181281311_section1973216914514"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0087__en-us_topic_0181281311_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p131491731112013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0087__b287591254617">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0087__en-us_topic_0181281311_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0087__en-us_topic_0181281311_section561243517589"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p7541145513348">See the request parameters in <a href="dataartsstudio_02_0084.html">Creating a Job</a>.</p>
</div>
<div class="section" id="dataartsstudio_02_0087__en-us_topic_0181281311_section04571028119"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0087__en-us_topic_0181281311_p34231642125416">View details about job <strong id="dataartsstudio_02_0087__en-us_topic_0181281311_b11600217174310">myJob</strong>.</p>
<ul id="dataartsstudio_02_0087__en-us_topic_0181281311_ul763675312599"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_li1763615315598">Request<pre class="screen" id="dataartsstudio_02_0087__en-us_topic_0181281311_screen49871115389">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob</pre>
</li></ul>
<ul id="dataartsstudio_02_0087__en-us_topic_0181281311_ul3725916596"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_li3725913598">Success response<pre class="screen" id="dataartsstudio_02_0087__en-us_topic_0181281311_screen418141383819">{
"basicConfig": {
"instanceTimeout": 0,
"priority": 0
},
"logPath": "obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505",
"name": "myJob",
"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": "clusterName",
"value": "-1"
},
{
"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,
"engineType": "DIS",
"failPolicy": "CONTINUE",
"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_0087__en-us_topic_0181281311_ul1963180192413"><li id="dataartsstudio_02_0087__en-us_topic_0181281311_li313082312504">Failure response<p id="dataartsstudio_02_0087__en-us_topic_0181281311_p17868101111567"><a name="dataartsstudio_02_0087__en-us_topic_0181281311_li313082312504"></a><a name="en-us_topic_0181281311_li313082312504"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0087__en-us_topic_0181281311_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>