forked from docs/doc-exports

ModelArts GA API 06052022 from R&D R&D has provided a right version of ModelArts GA API (06052022) Reviewed-by: Artem Goncharov <Artem.goncharov@gmail.com>
273 lines
24 KiB
HTML
273 lines
24 KiB
HTML
<a name="modelarts_03_0064"></a><a name="modelarts_03_0064"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section694510305355"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p49028271474">This API is used to create a visualization job.</p>
|
|
<p id="modelarts_03_0064__en-us_topic_0131202682_p35011100">Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in <a href="modelarts_03_0065.html">Querying a Visualization Job List</a> and <a href="modelarts_03_0066.html">Querying the Details About a Visualization Job</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section20261580353"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p759811511271">POST /v1/{project_id}/visualization-jobs</p>
|
|
</div>
|
|
<div class="p" id="modelarts_03_0064__en-us_topic_0131202682_p11230174318478"><a href="#modelarts_03_0064__en-us_topic_0131202682_table569625523811">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0064__en-us_topic_0131202682_table569625523811"></a><a name="en-us_topic_0131202682_table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0064__en-us_topic_0131202682_table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0064__en-us_topic_0131202682_row169945510386"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.2.2.5.1.1"><p id="modelarts_03_0064__en-us_topic_0131202682_p370019557384">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.2"><p id="modelarts_03_0064__en-us_topic_0131202682_p2702115512388">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.5.1.3"><p id="modelarts_03_0064__en-us_topic_0131202682_p1704955163819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.3.2.2.5.1.4"><p id="modelarts_03_0064__en-us_topic_0131202682_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0064__en-us_topic_0131202682_row187062555388"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p570711558389">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1070819552389">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p147095558384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p4972959911831">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section722833995517"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p539410249486"><a href="#modelarts_03_0064__en-us_topic_0131202682_table196759327241">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0064__en-us_topic_0131202682_table196759327241"></a><a name="en-us_topic_0131202682_table196759327241"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0064__en-us_topic_0131202682_table196759327241" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0064__en-us_topic_0131202682_row1674173272415"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.4.3.2.5.1.1"><p id="modelarts_03_0064__en-us_topic_0131202682_p367417321244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.4.3.2.5.1.2"><p id="modelarts_03_0064__en-us_topic_0131202682_p4674153213242">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.4.3.2.5.1.3"><p id="modelarts_03_0064__en-us_topic_0131202682_p1674032172414">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.505050505050505%" id="mcps1.3.4.3.2.5.1.4"><p id="modelarts_03_0064__en-us_topic_0131202682_p1866917542396">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0064__en-us_topic_0131202682_row15675193219249"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p126741032182417">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p2674432102419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p667553211247">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p10675123272415">Name of a visualization job. The value must contain 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row196751932142417"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p4675932152410">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1967503217244">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p106755321246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p5675153202417">Description of a visualization job. The value must contain 0 to 256 characters. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row2067513212417"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p18675632162419">train_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1767519321242">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1267518326249">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p8675032122411">OBS path</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row1815274403111"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p015274415311">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1815217443319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p20152124443112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p215217447311">Type of a visualization job. You can create visualization jobs of TensorBoard and MindInsight types. The default type is TensorBoard.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row5405137113114"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p10406537203116">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p240673783114">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p184061137173115">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p10406537113117">Specifications when a visualization job is created. You do not need to set this parameter. For details, see <a href="#modelarts_03_0064__en-us_topic_0131202682_table18319659123214">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row47245220168"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.3.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p0728527168">schedule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p0734529165">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.3.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p187385214162">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.3.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p87365201611">Auto stop setting. For details, see <a href="#modelarts_03_0064__en-us_topic_0131202682_table3694202918279">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0064__en-us_topic_0131202682_table18319659123214"></a><a name="en-us_topic_0131202682_table18319659123214"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0064__en-us_topic_0131202682_table18319659123214" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_03_0064__en-us_topic_0131202682_b11693104517373">flavor</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0064__en-us_topic_0131202682_row4319205920324"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.4.4.2.5.1.1"><p id="modelarts_03_0064__en-us_topic_0131202682_p1931911594326">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.4.4.2.5.1.2"><p id="modelarts_03_0064__en-us_topic_0131202682_p2031995914327">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.4.4.2.5.1.3"><p id="modelarts_03_0064__en-us_topic_0131202682_p1731935983218">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.505050505050505%" id="mcps1.3.4.4.2.5.1.4"><p id="modelarts_03_0064__en-us_topic_0131202682_p1131925953210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0064__en-us_topic_0131202682_row531935933216"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.4.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p331985917322">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.4.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p03194596321">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.4.4.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1531935916325">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.4.4.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1027352063417">Resource specification code of a visualization job. You can obtain the code through the <strong id="modelarts_03_0064__en-us_topic_0131202682_b256313515231">flavor</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0064__en-us_topic_0131202682_table3694202918279"></a><a name="en-us_topic_0131202682_table3694202918279"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0064__en-us_topic_0131202682_table3694202918279" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0064__en-us_topic_0131202682_b3188115617372">schedule</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0064__en-us_topic_0131202682_row16694152902716"><th align="left" class="cellrowborder" valign="top" width="19.387755102040817%" id="mcps1.3.4.5.2.5.1.1"><p id="modelarts_03_0064__en-us_topic_0131202682_p1769482911278">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.306122448979592%" id="mcps1.3.4.5.2.5.1.2"><p id="modelarts_03_0064__en-us_topic_0131202682_p1069462912275">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.285714285714288%" id="mcps1.3.4.5.2.5.1.3"><p id="modelarts_03_0064__en-us_topic_0131202682_p969462918273">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.02040816326531%" id="mcps1.3.4.5.2.5.1.4"><p id="modelarts_03_0064__en-us_topic_0131202682_p20694329102716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0064__en-us_topic_0131202682_row17694102992717"><td class="cellrowborder" valign="top" width="19.387755102040817%" headers="mcps1.3.4.5.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p46942294270">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.306122448979592%" headers="mcps1.3.4.5.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p36946298274">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.285714285714288%" headers="mcps1.3.4.5.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p126949296275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.02040816326531%" headers="mcps1.3.4.5.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p15775050172812">Set this parameter to <strong id="modelarts_03_0064__en-us_topic_0131202682_b3466993347">stop</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row8695132916272"><td class="cellrowborder" valign="top" width="19.387755102040817%" headers="mcps1.3.4.5.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p10422910284">time_unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.306122448979592%" headers="mcps1.3.4.5.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p18695172915278">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.285714285714288%" headers="mcps1.3.4.5.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p7695829202718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.02040816326531%" headers="mcps1.3.4.5.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p2129144214285">Unit of auto stop duration. The value is <strong id="modelarts_03_0064__en-us_topic_0131202682_b216725173313">HOURS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row7695182992717"><td class="cellrowborder" valign="top" width="19.387755102040817%" headers="mcps1.3.4.5.2.5.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p26321380271">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.306122448979592%" headers="mcps1.3.4.5.2.5.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p196325386273">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.285714285714288%" headers="mcps1.3.4.5.2.5.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p13631143862720">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.02040816326531%" headers="mcps1.3.4.5.2.5.1.4 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1263193812271">Auto stop duration. The value ranges from 0 to 24.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section27400369"><h4 class="sectiontitle">Response Body</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p14980301507"><a href="#modelarts_03_0064__en-us_topic_0131202682_table28681002612">Table 5</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0064__en-us_topic_0131202682_table28681002612"></a><a name="en-us_topic_0131202682_table28681002612"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0064__en-us_topic_0131202682_table28681002612" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0064__en-us_topic_0131202682_row2848102261"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.3.2.4.1.1"><p id="modelarts_03_0064__en-us_topic_0131202682_p108341042617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.2.4.1.2"><p id="modelarts_03_0064__en-us_topic_0131202682_p158421082617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.5.3.2.4.1.3"><p id="modelarts_03_0064__en-us_topic_0131202682_p163891557133919">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0064__en-us_topic_0131202682_row1784111014264"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1284111013261">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p148421014262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p66691317104320">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0064__en-us_topic_0131202682_p138471017269">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row168691012617"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p88419109266">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1384171011268">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1712291610431">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="modelarts_03_0064__en-us_topic_0131202682_p78671014266">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row717928165716"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p10880115015305">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p7880145016307">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p98801650193016">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row193841384578"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p11880145003011">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1288005011309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1388035012303">Name of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row198258825713"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p2880185010304">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p0880205010309">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p4587851163110">Status of a visualization job. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row17438914576"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p088075023010">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p1850516261810">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p988111507304">Time when a visualization job is created, in timestamp format</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0064__en-us_topic_0131202682_row1721598454"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0064__en-us_topic_0131202682_p728593454">service_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0064__en-us_topic_0131202682_p172459184516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0064__en-us_topic_0131202682_p11245994520">Endpoint of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section193620280518"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p132041535175114">The following shows how to create a visualization job whose name is <span class="parmvalue" id="modelarts_03_0064__en-us_topic_0131202682_parmvalue10101214151913"><b>visualization-job</b></span>, description is <span class="parmvalue" id="modelarts_03_0064__en-us_topic_0131202682_parmvalue12889223151912"><b>this is a visualization job</b></span>, and OBS path is <span class="filepath" id="modelarts_03_0064__en-us_topic_0131202682_filepath1522353041918"><b>/obs/name/</b></span>.</p>
|
|
</div>
|
|
<ul id="modelarts_03_0064__en-us_topic_0131202682_ul211620355548"><li id="modelarts_03_0064__en-us_topic_0131202682_li2011673565417">Sample request<pre class="screen" id="modelarts_03_0064__en-us_topic_0131202682_screen4126401984">POST https://endpoint/v1/{project_id}/visualization-jobs
|
|
{
|
|
"job_name": "visualization-job",
|
|
"job_desc": "this is a visualization job",
|
|
"train_url": "/obs/name/",
|
|
"job_type": "mindinsight",
|
|
"schedule": [
|
|
{
|
|
"type": "stop",
|
|
"time_unit": "HOURS",
|
|
"duration": 1
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0064__en-us_topic_0131202682_ul53949288512"><li id="modelarts_03_0064__en-us_topic_0131202682_li163941428105115">Successful sample response<pre class="screen" id="modelarts_03_0064__en-us_topic_0131202682_screen79055461389">{
|
|
"is_success": true,
|
|
"job_id": "10",
|
|
"job_name": "visualization-job",
|
|
"status": "1",
|
|
"create_time": "1524189990635"
|
|
}</pre>
|
|
</li><li id="modelarts_03_0064__en-us_topic_0131202682_li18394928195119">Failed sample response<pre class="screen" id="modelarts_03_0064__en-us_topic_0131202682_screen55926541485">{
|
|
"is_success": false,
|
|
"error_message": "error message",
|
|
"error_code": "ModelArts.0103"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0064__en-us_topic_0131202682_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0064__en-us_topic_0131202682_p63851506163">For details about the status code, see <a href="modelarts_03_0094.html#modelarts_03_0094__en-us_topic_0132773864_table1450010510213">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0064__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0064__p1572811255123">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0063.html">Visualization Jobs</a></div>
|
|
</div>
|
|
</div>
|
|
|