vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0065.html
Wuwan, Qi f81ead2467 ModelArts API 24.3.0 20241128 version 
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>
2024-11-29 09:04:54 +00:00

291 lines
24 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001909747448"></a><a name="EN-US_TOPIC_0000001909747448"></a>
<h1 class="topictitle1">Querying a Visualization Job List</h1>
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000001909747448__section694510305355"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909747448__p35011100">This API is used to obtain the visualization jobs that meet the search criteria.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section20261580353"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909747448__p134043619914">GET /v1/{project_id}/visualization-jobs</p>
</div>
<div class="p" id="EN-US_TOPIC_0000001909747448__p894454115614"><a href="#EN-US_TOPIC_0000001909747448__table569625523811">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747448__table569625523811"></a><a name="table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747448__table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747448__row169945510386"><th align="left" class="cellrowborder" valign="top" width="15.5%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909747448__p370019557384">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.78%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909747448__p2702115512388">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.540000000000001%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909747448__p1704955163819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.18%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909747448__p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747448__row187062555388"><td class="cellrowborder" valign="top" width="15.5%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p570711558389">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.78%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p1070819552389">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.540000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p147095558384">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.18%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__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="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747448__table34584035" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747448__row11781178"><th align="left" class="cellrowborder" valign="top" width="15.61%" id="mcps1.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001909747448__p14751348">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.91%" id="mcps1.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001909747448__p54008559">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.15%" id="mcps1.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001909747448__p12617171">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.330000000000005%" id="mcps1.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001909747448__p73888315404">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747448__row36029939"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p32743936">status</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p35013141">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p17492187">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p7581049">Job status. By default, all job statuses are returned. For example, to obtain failed jobs, set the value of <strong id="EN-US_TOPIC_0000001909747448__b9103182103818">status</strong> to <strong id="EN-US_TOPIC_0000001909747448__b177511547380">3</strong>, <strong id="EN-US_TOPIC_0000001909747448__b166223719387">5</strong>, <strong id="EN-US_TOPIC_0000001909747448__b43201995389">6</strong>, or <strong id="EN-US_TOPIC_0000001909747448__b53601912153814">13</strong>. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1120585"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p23658592">per_page</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p37297762">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p1219897">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p31702861">Number of jobs displayed on each page. The value range is [1, 1000]. Default value: <span class="parmvalue" id="EN-US_TOPIC_0000001909747448__parmvalue1029184913100"><b>10</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row16890297"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p25936818">page</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p20507548">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p50498719">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p63864418">Index of the page to be queried. Default value: <span class="parmvalue" id="EN-US_TOPIC_0000001909747448__parmvalue206491657161016"><b>1</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row37908851"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p50718073">sortBy</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p14523285">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p35535404">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p59795496">Sorting mode of the query. The value can be <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname1472353511250"><b>job_id</b></span>, <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname4728193518256"><b>job_name</b></span>, <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname15728203510253"><b>job_desc</b></span>, <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname1372820356254"><b>create_time</b></span>, or <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname57281735172510"><b>status</b></span>. Default value: <span class="parmname" id="EN-US_TOPIC_0000001909747448__parmname19728173511258"><b>job_id</b></span></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1288560"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p37264510">order</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p65635300">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p14859083">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p14101615101012">Sorting order. Options:</p>
<ul id="EN-US_TOPIC_0000001909747448__ul96861712131016"><li id="EN-US_TOPIC_0000001909747448__li146861412151013"><span class="parmvalue" id="EN-US_TOPIC_0000001909747448__parmvalue13838533135111"><b>asc</b></span>: ascending order. It is the default value.</li><li id="EN-US_TOPIC_0000001909747448__li0686712191010"><span class="parmvalue" id="EN-US_TOPIC_0000001909747448__parmvalue33457418518"><b>desc</b></span>: descending order</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row27744689"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p32727312">search_content</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p33666604">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p42640364">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p31317432">Search content, for example, a visualization job name. The value must contain 0 to 64 characters. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1052583211177"><td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747448__p1252620323174">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747448__p13526143210174">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747448__p65261832101710">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.330000000000005%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747448__p652613213178">Workspace where a job resides. Default value: <strong id="EN-US_TOPIC_0000001909747448__b822210753815">0</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section722833995517"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909747448__p735115018591">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section54078976"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909747448__p1141659591"><a href="#EN-US_TOPIC_0000001909747448__table116520556267">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747448__table116520556267"></a><a name="table116520556267"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747448__table116520556267" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747448__row8631155102617"><th align="left" class="cellrowborder" valign="top" width="17.73%" id="mcps1.3.6.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909747448__p106165572612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.19%" id="mcps1.3.6.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909747448__p56325542614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.08%" id="mcps1.3.6.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909747448__p06303714014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747448__row18201110111914"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1164155522614"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p688954611624">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p3804851211624">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p31621956104211">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_0000001909747448__p6203060911624">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row156417555261"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p4368550411624">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p6574380911624">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p124956134312">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001909747448__p2364831411624">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row7249833153018"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p90064711624">job_total_count</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p356648511624">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p2044987311624">Total number of the queried visualization jobs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row12250633103012"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p978994011624">job_count_limit</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p861842511624">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p2700383011624">Number of visualization jobs that can be created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row6251153343012"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p2289544311624">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p2736646611624"><strong id="EN-US_TOPIC_0000001909747448__b1994771122111">jobs</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p209129111624">Visualization job attributes. For details, see <a href="#EN-US_TOPIC_0000001909747448__table5856678611720">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row78959283379"><td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p1489512816374">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="13.19%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p389513285373">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="69.08%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p198951228143720">Maximum number of training jobs</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747448__table5856678611720"></a><a name="table5856678611720"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747448__table5856678611720" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001909747448__b1688834941411">jobs</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747448__row5442734111720"><th align="left" class="cellrowborder" valign="top" width="17.66%" id="mcps1.3.7.2.4.1.1"><p id="EN-US_TOPIC_0000001909747448__p1152466011735">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.18%" id="mcps1.3.7.2.4.1.2"><p id="EN-US_TOPIC_0000001909747448__p6108225611735">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.16%" id="mcps1.3.7.2.4.1.3"><p id="EN-US_TOPIC_0000001909747448__p96431954019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747448__row5375420411720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p5106217311735">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p4239538711735">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p1147433311735">Name of a visualization job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row6415138911720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p3751437211735">status</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p1876525711735">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p4359082611735">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_0000001909747448__row3283158911720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p4854563511735">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p3988237811735">Long</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p924721411735">Time when a visualization job is created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1504887811720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p3033297111735">duration</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p4105162111735">Long</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p3684703211735">Visualization job running duration, in milliseconds</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row3760771211720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p1794090011735">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p4392677811735">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p129930211735">Description of a visualization job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row272279211720"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p766713111735">service_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p1705789711735">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p3951239111735">Endpoint of a visualization job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row1439522011725"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p1483044111735">train_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p6041506311735">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p6178193811735">Path for storing visualization job logs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row162330153811"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p16243043819">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p122183053815">Long</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p5215309382">ID of a visualization job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747448__row112610169390"><td class="cellrowborder" valign="top" width="17.66%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747448__p8261416173914">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747448__p1226616193918">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.16%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747448__p126121663910">Charged resource ID of a visualization job</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section89351017175815"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909747448__p10331182035811">The following shows how to obtain the top 10 visualization jobs that are being deployed on the first page in ascending order.</p>
<div class="p" id="EN-US_TOPIC_0000001909747448__p778882319"><pre class="screen" id="EN-US_TOPIC_0000001909747448__screen6115865415">GET https://endpoint/v1/{project_id}/visualization-jobs ?status=7&amp;per_page=10&amp;page=1&amp;sortBy=status&amp;order=asc&amp; search_content=job_name</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section926031918313"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909747448__ul125103513317"><li id="EN-US_TOPIC_0000001909747448__li82519352317">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909747448__screen19251735538">{
"quotas": 100,
"is_success": true,
"job_total_count": 1,
"job_count_limit": 999,
"jobs": [
{
"job_id": 1,
"job_name": "visualization-job",
"status": 1,
"create_time": 15099239923,
"resource_id": "4787c885-e18d-4ef1-aa12-c4ed0c364b27",
"duration": 1502323,
"job_desc": "This is a visualization job",
"service_url": "https://XXX/modelarts/tensoarbod/xxxx/111",
"train_url": "/obs/name/"
}
]
}</pre>
</li><li id="EN-US_TOPIC_0000001909747448__li52523351631">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909747448__screen1125293519320">{
"is_success": false,
"error_message": "error message",
"error_code": "ModelArts.0103"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747448__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909747448__p1731954913014">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>
View Git Blame Copy Permalink