forked from docs/doc-exports
Lai, Weijian
eda19245f1
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com> Reviewed-by: Rechenburg, Matthias <matthias.rechenburg@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
104 lines
11 KiB
HTML
104 lines
11 KiB
HTML
<a name="modelarts_04_0186"></a><a name="modelarts_04_0186"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_section35881040102516"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0186__en-us_topic_0180094077_p12756014154619">In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see <a href="modelarts_04_0123.html">Session Authentication</a>.</p>
|
|
<ul id="modelarts_04_0186__en-us_topic_0180094077_ul1360176676"><li id="modelarts_04_0186__en-us_topic_0180094077_li163601468716">Method 1: Stop a visualization job based on the specified <strong id="modelarts_04_0186__en-us_topic_0180094077_b12725194735617">visualization_id</strong>.<div class="codecoloring" codetype="Python" id="modelarts_04_0186__en-us_topic_0180094077_screen1894117377"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
|
<span class="normal">2</span>
|
|
<span class="normal">3</span>
|
|
<span class="normal">4</span>
|
|
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="kn">from</span> <span class="nn">modelarts.session</span> <span class="kn">import</span> <span class="n">Session</span>
|
|
<span class="kn">from</span> <span class="nn">modelarts.estimator</span> <span class="kn">import</span> <span class="n">VisualizationJob</span>
|
|
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
|
|
<span class="n">job</span> <span class="o">=</span> <span class="n">VisualizationJob</span><span class="p">(</span><span class="n">modelarts_session</span><span class="o">=</span><span class="n">session</span><span class="p">,</span> <span class="n">visualization_id</span><span class="o">=</span><span class="s1">'8992'</span><span class="p">)</span>
|
|
<span class="n">status</span> <span class="o">=</span> <span class="n">job</span><span class="o">.</span><span class="n">stop_visualization_job</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0186__en-us_topic_0180094077_ul52321393716"><li id="modelarts_04_0186__en-us_topic_0180094077_li1923269478">Method 2: Stop the visualization job created in <a href="modelarts_04_0181.html">Creating a Visualization Job</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0186__en-us_topic_0180094077_screen194729268710"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">status</span> <span class="o">=</span> <span class="n">job_visualization_instance</span><span class="o">.</span><span class="n">stop_visualization_job</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0186__en-us_topic_0180094077_ul172816121878"><li id="modelarts_04_0186__en-us_topic_0180094077_li112821712173">Method 3: Stop the visualization job object returned in <a href="modelarts_04_0182.html">Querying the List of Visualization Job Objects</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0186__en-us_topic_0180094077_screen197610344718"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">status</span> <span class="o">=</span> <span class="n">job_visualization_instance_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stop_visualization_job</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_section85751315416"><h4 class="sectiontitle">Parameter Description</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_table155461191218" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="modelarts_04_0186__en-us_topic_0180094077_b192591046195912">VisualizationJob</strong> request parameters</caption><thead align="left"><tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row254817912212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.5.1.1"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p12549899214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.2.2.5.1.2"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p3552101193813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.2.2.5.1.3"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p1755169172118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.2.2.5.1.4"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p55521998211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row8893215413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p6891421842">modelarts_session</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p68972047">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p158912219419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p1689152543">Session object. For details about the initialization method, see <a href="modelarts_04_0123.html">Session Authentication</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row197933582219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p9118145011917">visualization_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.5.1.2 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p196751771039">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p8675972311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p212635661310">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_table55928961173927" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="modelarts_04_0186__en-us_topic_0180094077_b675141813445">stop_visualization_job</strong> response parameters</caption><thead align="left"><tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row40618446173927"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.4.1.1"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p1631242217407">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.4.1.2"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p5427574117407">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.2.3.2.4.1.3"><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p3425893817407">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row11062410173927"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p688954611624">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p3804851211624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p19895181231810">Error code when the API fails to be called. For details, see <a href="https://docs.otc.t-systems.com/modelarts/api-ref/common_parameters/error_codes.html" target="_blank" rel="noopener noreferrer">Error Codes</a> in <em id="modelarts_04_0186__i294812482371">ModelArts API Reference</em>.</p>
|
|
<p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p6203060911624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row52351653173927"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p4368550411624">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p6574380911624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p1143593112814">Error message when the API call fails.</p>
|
|
<p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p2364831411624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_row15215104313513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p123221015210">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p923219101219">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0186__en-us_topic_0180094077_en-us_topic_0170904411_p14433359122514">Whether the API call succeeds</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_04_0180.html">Visualization Jobs</a></div>
|
|
</div>
|
|
</div>
|
|
|