forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
278 lines
23 KiB
HTML
278 lines
23 KiB
HTML
<a name="EN-US_TOPIC_0000001909907520"></a><a name="EN-US_TOPIC_0000001909907520"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Visualization Job</h1>
|
|
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000001909907520__section694510305355"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907520__p49028271474">This API is used to create a visualization job.</p>
|
|
<p id="EN-US_TOPIC_0000001909907520__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="EN-US_TOPIC_0000001909907520__section20261580353"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907520__p759811511271">POST /v1/{project_id}/visualization-jobs</p>
|
|
</div>
|
|
<div class="p" id="EN-US_TOPIC_0000001909907520__p11230174318478"><a href="#EN-US_TOPIC_0000001909907520__table569625523811">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907520__table569625523811"></a><a name="table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907520__table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907520__row169945510386"><th align="left" class="cellrowborder" valign="top" width="21.16%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907520__p370019557384">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.87%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907520__p2702115512388">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.190000000000001%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907520__p1704955163819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.78%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907520__p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907520__row187062555388"><td class="cellrowborder" valign="top" width="21.16%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p570711558389">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1070819552389">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.190000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p147095558384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p4972959911831">Project ID. For details about how to obtain a project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907520__section722833995517"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909907520__p539410249486"><a href="#EN-US_TOPIC_0000001909907520__table196759327241">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907520__table196759327241"></a><a name="table196759327241"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907520__table196759327241" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907520__row1674173272415"><th align="left" class="cellrowborder" valign="top" width="22.343434343434346%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001909907520__p367417321244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.747474747474747%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001909907520__p4674153213242">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.787878787878787%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001909907520__p1674032172414">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.12121212121212%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001909907520__p1866917542396">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907520__row15675193219249"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p126741032182417">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p2674432102419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p667553211247">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__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="EN-US_TOPIC_0000001909907520__row196751932142417"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p4675932152410">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1967503217244">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p106755321246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__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="EN-US_TOPIC_0000001909907520__row2067513212417"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p18675632162419">train_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1767519321242">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p1267518326249">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p8675032122411">OBS path</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row1815274403111"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p015274415311">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1815217443319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p20152124443112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__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="EN-US_TOPIC_0000001909907520__row5405137113114"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p10406537203116">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p240673783114">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p184061137173115">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p10406537113117">Specifications when a visualization job is created. You do not need to set this parameter. For details, see <a href="#EN-US_TOPIC_0000001909907520__table18319659123214">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row47245220168"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p0728527168">schedule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p0734529165">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p187385214162">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p87365201611">Auto stop setting. For details, see <a href="#EN-US_TOPIC_0000001909907520__table3694202918279">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907520__table18319659123214"></a><a name="table18319659123214"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907520__table18319659123214" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001909907520__b11693104517373">flavor</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907520__row4319205920324"><th align="left" class="cellrowborder" valign="top" width="22.343434343434346%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001909907520__p1931911594326">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.747474747474747%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001909907520__p2031995914327">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.787878787878787%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001909907520__p1731935983218">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.12121212121212%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001909907520__p1131925953210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907520__row531935933216"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p331985917322">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p03194596321">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p1531935916325">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p1027352063417">Resource specification code of a visualization job. You can obtain the code through the <strong id="EN-US_TOPIC_0000001909907520__b256313515231">flavor</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907520__table3694202918279"></a><a name="table3694202918279"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907520__table3694202918279" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001909907520__b3188115617372">schedule</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907520__row16694152902716"><th align="left" class="cellrowborder" valign="top" width="22.343434343434346%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000001909907520__p1769482911278">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.747474747474747%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000001909907520__p1069462912275">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.787878787878787%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000001909907520__p969462918273">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.12121212121212%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000001909907520__p20694329102716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907520__row17694102992717"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p46942294270">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p36946298274">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p126949296275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p15775050172812">Set this parameter to <strong id="EN-US_TOPIC_0000001909907520__b3466993347">stop</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row8695132916272"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p10422910284">time_unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p18695172915278">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p7695829202718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p2129144214285">Unit of auto stop duration. The value is <strong id="EN-US_TOPIC_0000001909907520__b216725173313">HOURS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row7695182992717"><td class="cellrowborder" valign="top" width="22.343434343434346%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907520__p26321380271">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.747474747474747%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907520__p196325386273">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.787878787878787%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907520__p13631143862720">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12121212121212%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907520__p1263193812271">Auto stop duration. The value ranges from 0 to 24.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907520__section27400369"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0000001909907520__p14980301507"><a href="#EN-US_TOPIC_0000001909907520__table28681002612">Table 5</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907520__table28681002612"></a><a name="table28681002612"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907520__table28681002612" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907520__row2848102261"><th align="left" class="cellrowborder" valign="top" width="25.929999999999996%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909907520__p108341042617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.82%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909907520__p158421082617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.25%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909907520__p163891557133919">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907520__row119331951111816"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row1784111014264"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p1284111013261">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p148421014262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p66691317104320">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909907520__p138471017269">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row168691012617"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p88419109266">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1384171011268">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p1712291610431">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="EN-US_TOPIC_0000001909907520__p78671014266">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row717928165716"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p10880115015305">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p7880145016307">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p98801650193016">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row193841384578"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p11880145003011">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1288005011309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p1388035012303">Name of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row198258825713"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p2880185010304">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p0880205010309">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__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="EN-US_TOPIC_0000001909907520__row17438914576"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p088075023010">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p1850516261810">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p988111507304">Time when a visualization job is created, in timestamp format</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907520__row1721598454"><td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907520__p728593454">service_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907520__p172459184516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.25%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907520__p11245994520">Endpoint of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907520__section193620280518"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909907520__p132041535175114">The following shows how to create a visualization job whose name is <span class="parmvalue" id="EN-US_TOPIC_0000001909907520__parmvalue10101214151913"><b>visualization-job</b></span>, description is <span class="parmvalue" id="EN-US_TOPIC_0000001909907520__parmvalue12889223151912"><b>this is a visualization job</b></span>, and OBS path is <span class="filepath" id="EN-US_TOPIC_0000001909907520__filepath1522353041918"><b>/obs/name/</b></span>.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909907520__screen123323612522">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>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907520__section65572391126"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909907520__ul21769491322"><li id="EN-US_TOPIC_0000001909907520__li91769492210">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909907520__screen41761749221">{
|
|
"is_success": true,
|
|
"job_id": "10",
|
|
"job_name": "visualization-job",
|
|
"status": "1",
|
|
"create_time": "1524189990635"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001909907520__li191761949524">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909907520__screen20176204920220">{
|
|
"is_success": false,
|
|
"error_message": "error message",
|
|
"error_code": "ModelArts.0103"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907520__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909907520__p63851506163">For details about the status code, see <a href="modelarts_03_0094.html#EN-US_TOPIC_0000001909907492__table1450010510213">Table 1</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>
|
|
|