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>
167 lines
17 KiB
HTML
167 lines
17 KiB
HTML
<a name="modelarts_04_0184"></a><a name="modelarts_04_0184"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Details About a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_section35881040102516"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0184__en-us_topic_0180094075_p1285975419458">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_0184__en-us_topic_0180094075_ul186651420519"><li id="modelarts_04_0184__en-us_topic_0180094075_li986741417518">Method 1: Use the specified <strong id="modelarts_04_0184__en-us_topic_0180094075_b165752219305">visualization_id</strong>.<div class="codecoloring" codetype="Python" id="modelarts_04_0184__en-us_topic_0180094075_screen16776132213519"><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">job_info</span> <span class="o">=</span> <span class="n">job</span><span class="o">.</span><span class="n">get_visualization_job_info</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0184__en-us_topic_0180094075_ul48161717857"><li id="modelarts_04_0184__en-us_topic_0180094075_li08168171514">Method 2: Use the visualization job created in <a href="modelarts_04_0181.html">Creating a Visualization Job</a>.<div class="codecoloring" codetype="Python" id="modelarts_04_0184__en-us_topic_0180094075_screen14383153112516"><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">job_info</span> <span class="o">=</span> <span class="n">job_visualization_instance</span><span class="o">.</span><span class="n">get_visualization_job_info</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
<ul id="modelarts_04_0184__en-us_topic_0180094075_ul0823141911512"><li id="modelarts_04_0184__en-us_topic_0180094075_li8823111914520">Method 3: Use 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_0184__en-us_topic_0180094075_screen1299317381151"><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">job_info</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">get_visualization_job_info</span><span class="p">()</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_section85751315416"><h4 class="sectiontitle">Parameter Description</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_table155461191218" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="modelarts_04_0184__en-us_topic_0180094075_b949310910316">VisualizationJob</strong> request parameters</caption><thead align="left"><tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row254817912212"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.2.2.5.1.1"><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p3552101193813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.5.1.3"><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p55521998211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row8893215413"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p68972047">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p158912219419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_row197933582219"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.2.5.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p196751771039">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.5.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p8675972311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.5.1.4 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p212635661310">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_table55928961173927" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="modelarts_04_0184__en-us_topic_0180094075_b126623255117">get_visualization_job_info</strong> response parameters</caption><thead align="left"><tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row40618446173927"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.4.1.1"><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p5427574117407">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.2.3.2.4.1.3"><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p3425893817407">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row11062410173927"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p3804851211624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p15155170151818">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_0184__i666573618354">ModelArts API Reference</em>.</p>
|
|
<p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p6203060911624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row52351653173927"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p6574380911624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p102581118486">Error message when the API call fails.</p>
|
|
<p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p2364831411624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row63643119173927"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p124281540164214">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p13430144034215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p6433940124210">Name of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row82863719421"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p84681340164211">service_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p14469204044211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p44715401429">Endpoint of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row823221010216"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_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_0184__en-us_topic_0180094075_en-us_topic_0170904409_p923219101219">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p14433359122514">Whether the API call succeeds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row02381259141816"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p1623912593182">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p81055447198">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p10105194441916">Running duration of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row1223120141910"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p1623171101913">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p199521910218">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p1437875772113">Time when a visualization job is created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row16321198181917"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p6322381192">train_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p4471037122511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p1465683720343">OBS path to the visualization job output file</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row11556617202"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p19551166202">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p9528172311319">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p652892311314">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row20917116202"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p12106117206">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p1779454151314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p127975417138">Description of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_row197321312162017"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p173221202010">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p69469566192">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_en-us_topic_0170904409_p97324127201">Resource ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0184__en-us_topic_0180094075_row3237829142413"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.4.1.1 "><p id="modelarts_04_0184__en-us_topic_0180094075_p2012711881316">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.4.1.2 "><p id="modelarts_04_0184__en-us_topic_0180094075_p11127086133">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.2.3.2.4.1.3 "><p id="modelarts_04_0184__en-us_topic_0180094075_p512719801315">Status of a visualization job. For details about job statuses, see <a href="modelarts_04_0077.html">Job Statuses</a>.</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>
|
|
|