vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0046.html
Beibei 525370b67d
ModelArts GA API 06052022 from R&D (#14) 
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>
2022-05-23 16:26:34 +00:00

285 lines
26 KiB
HTML
Raw Blame History

<a name="modelarts_03_0046"></a><a name="modelarts_03_0046"></a>
<h1 class="topictitle1">Querying a Training Job List</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section528664"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0046__en-us_topic_0131145861_p29722048">This API is used to query the created training jobs that meet the search criteria.</p>
</div>
<div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section4757982"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0046__en-us_topic_0131145861_p0218181715712">GET /v1/{project_id}/training-jobs</p>
<div class="p" id="modelarts_03_0046__en-us_topic_0131145861_p10971184713425"><a href="#modelarts_03_0046__en-us_topic_0131145861_table16518993181628">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0046__en-us_topic_0131145861_table16518993181628"></a><a name="en-us_topic_0131145861_table16518993181628"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0046__en-us_topic_0131145861_table16518993181628" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="modelarts_03_0046__en-us_topic_0131145861_row41524868181628"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0046__en-us_topic_0131145861_p30350749181639">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0046__en-us_topic_0131145861_p42491604181639">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0046__en-us_topic_0131145861_p19267891181639">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0046__en-us_topic_0131145861_p17195363181639">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0046__en-us_topic_0131145861_row6770181628"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p8780885181639">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p40163046181639">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p31981288181639">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p40347522181639">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="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0046__en-us_topic_0131145861_table166417321355" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="modelarts_03_0046__en-us_topic_0131145861_row46411832956"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.4.2.5.1.1"><p id="modelarts_03_0046__en-us_topic_0131145861_p126419324510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.4.2.5.1.2"><p id="modelarts_03_0046__en-us_topic_0131145861_p186427321353">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.4.2.5.1.3"><p id="modelarts_03_0046__en-us_topic_0131145861_p186427326517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.2.4.2.5.1.4"><p id="modelarts_03_0046__en-us_topic_0131145861_p364217320515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0046__en-us_topic_0131145861_row76421632158"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p196428322515">status</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1164219326511">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p20642232953">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p196421332855">Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of <strong id="modelarts_03_0046__en-us_topic_0131145861_b66214111737">status</strong> to <strong id="modelarts_03_0046__en-us_topic_0131145861_b4167271953">3</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b207919291355">5</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b132823116520">6</strong>, or <strong id="modelarts_03_0046__en-us_topic_0131145861_b1512511332518">13</strong>. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row06428320515"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p764213212519">per_page</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p9642113213516">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p10642143215519">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p464215323515">Number of jobs displayed on each page. The value range is [1, 1000]. Default value: <strong id="modelarts_03_0046__en-us_topic_0131145861_b83789561675">10</strong></p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row86424321853"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p16642173211513">page</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p864203217511">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p164215321511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p46425321550">Index of the page to be queried. Default value: <strong id="modelarts_03_0046__en-us_topic_0131145861_b10206143413914">1</strong> The value range is [1, 65535].</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row564215324511"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1164210326519">sortBy</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p66421332855">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p96424322510">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p864216326516">Sorting mode of the query. The value can be <strong id="modelarts_03_0046__en-us_topic_0131145861_b1161419179111">job_name</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b17504920161115">job_desc</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b1581112620111">status</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b13973112817114">duration</strong>, <strong id="modelarts_03_0046__en-us_topic_0131145861_b16348183313110">version_count</strong>, or <strong id="modelarts_03_0046__en-us_topic_0131145861_b6426153711114">create_time</strong>. Default value: <strong id="modelarts_03_0046__en-us_topic_0131145861_b19571468110">job_name</strong></p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row1464214323511"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2064273214515">order</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p106425323519">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p176428321853">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1964210324515">Sorting order. The options are as follows:</p>
<ul id="modelarts_03_0046__en-us_topic_0131145861_ul19642632451"><li id="modelarts_03_0046__en-us_topic_0131145861_li18642173219516"><span class="parmvalue" id="modelarts_03_0046__en-us_topic_0131145861_parmvalue153636402291257"><b>asc</b></span>: ascending order. It is the default value.</li><li id="modelarts_03_0046__en-us_topic_0131145861_li13642532558"><span class="parmvalue" id="modelarts_03_0046__en-us_topic_0131145861_parmvalue185517008691327"><b>desc</b></span>: descending order</li></ul>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row8642183214519"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p196423321753">search_content</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p064218329520">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p564214329516">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1264219328517">Search content, for example, a training job name. The value must contain 0 to 64 characters. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row36428327510"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p96428326511">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p864219321452">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p764218321058">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0046__en-us_topic_0131145861_p664214327510">Workspace where a job resides. Default value: <strong id="modelarts_03_0046__en-us_topic_0131145861_b10528540203418">0</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section17382173235414"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0046__en-us_topic_0131145861_p11333135175510">None</p>
</div>
<div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section46017476"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0046__en-us_topic_0131145861_p15979103725811"><a href="#modelarts_03_0046__en-us_topic_0131145861_table31621671103510">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="modelarts_03_0046__en-us_topic_0131145861_table31621671103510"></a><a name="en-us_topic_0131145861_table31621671103510"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0046__en-us_topic_0131145861_table31621671103510" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0046__en-us_topic_0131145861_row43014294103510"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0046__en-us_topic_0131145861_p27237124103529">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0046__en-us_topic_0131145861_p58976351103529">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0046__en-us_topic_0131145861_p12355133103529">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0046__en-us_topic_0131145861_row6154121019310"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row197335051410"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p16741250101412">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p167419502147">String</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p06401316154">Error message of a failed API call.</p>
<p id="modelarts_03_0046__en-us_topic_0131145861_p5642163131513">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row16193448103510"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p21522350103529">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p11090557103529">String</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1251312531679">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
<p id="modelarts_03_0046__en-us_topic_0131145861_p25919895103529">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row45611722103510"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p11027791103529">job_total_count</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p9983934103529">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p3392343103529">Total number of created jobs</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row64404474103510"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p57099024103529">job_count_limit</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p25018653103529">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p13245051103529">Number of training jobs that can be created</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row49183900103510"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p59075084103529">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p37936844103529"><strong id="modelarts_03_0046__en-us_topic_0131145861_b1435521102311">jobs</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p52985513103529">Attributes of a training job. For details, see <a href="#modelarts_03_0046__en-us_topic_0131145861_table3971109103614">Table 4</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row1282745719345"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p148277570341">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p682715793413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1782745715344">Maximum number of training jobs</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="modelarts_03_0046__en-us_topic_0131145861_table3971109103614"></a><a name="en-us_topic_0131145861_table3971109103614"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0046__en-us_topic_0131145861_table3971109103614" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0046__en-us_topic_0131145861_b1965692753120">jobs</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0046__en-us_topic_0131145861_row7802134103614"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.3.2.4.1.1"><p id="modelarts_03_0046__en-us_topic_0131145861_p3311592314323">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.2.3.2.4.1.2"><p id="modelarts_03_0046__en-us_topic_0131145861_p6514409514323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71%" id="mcps1.3.4.2.3.2.4.1.3"><p id="modelarts_03_0046__en-us_topic_0131145861_p4218030314323">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0046__en-us_topic_0131145861_row5535123419151"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p15535183415158">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p11536103420154">Long</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p135361334151513">ID of a training job</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row7417784103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p5512274814323">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p3575764214323">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1068790014323">Name of a training job</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row5907113192214"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1909739228">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p6909231225">Long</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p1682219211685">Version ID of a training job</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row36417840103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p6057598714323">status</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p770788014323">Int</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2035852114323">Status of a training job. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row50389554103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2562267414323">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p152021491810">Long</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p266431714323">Timestamp when a training job is created</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row57875733103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p6323926614323">duration</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2210695614323">Long</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p4583303914323">Training job running duration, in milliseconds</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row14074438103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p5918019514323">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2886647314323">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p5648301314323">Description of a training job</p>
</td>
</tr>
<tr id="modelarts_03_0046__en-us_topic_0131145861_row30554942103614"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0046__en-us_topic_0131145861_p3838291414323">version_count</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0046__en-us_topic_0131145861_p2200835214323">Long</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0046__en-us_topic_0131145861_p86334528223">Number of versions of a training job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section2044281275719"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0046__en-us_topic_0131145861_p934031685719">The following shows how to query training jobs whose status is <strong id="modelarts_03_0046__en-us_topic_0131145861_b416116111366">7</strong> and whose name contains <strong id="modelarts_03_0046__en-us_topic_0131145861_b7553315173619">job</strong> on the first page. Each page displays 10 records sorted by <span class="parmvalue" id="modelarts_03_0046__en-us_topic_0131145861_parmvalue5639828111717"><b>job_name</b></span> in ascending order.</p>
<ul id="modelarts_03_0046__en-us_topic_0131145861_ul197155411577"><li id="modelarts_03_0046__en-us_topic_0131145861_li487543577">Sample request<pre class="screen" id="modelarts_03_0046__en-us_topic_0131145861_screen9976835111716">GET https://endpoint/v1/{project_id}/training-jobs?status=7&amp;per_page=10&amp;page=1&amp;sortBy=job_name&amp;order=asc&amp;search_content=job</pre>
</li></ul>
</div>
<ul id="modelarts_03_0046__en-us_topic_0131145861_ul19174109"><li id="modelarts_03_0046__en-us_topic_0131145861_li38349257">Successful sample response<pre class="screen" id="modelarts_03_0046__en-us_topic_0131145861_screen33261644151716">{
"is_success": true,
"quotas": 5,
"job_total_count": 1,
"job_count_limit": 3,
"jobs": [
{
"job_id": 10,
"job_name": "testModelArtsJob",
"version_id": 10,
"status": 10,
"create_time": 1524189990635,
"duration": 532003,
"job_desc": "This is ModelArts job",
"version_count": 5
}
]
}</pre>
</li><li id="modelarts_03_0046__en-us_topic_0131145861_li697916221660">Failed sample response<pre class="screen" id="modelarts_03_0046__en-us_topic_0131145861_screen74436528170">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
<div class="section" id="modelarts_03_0046__en-us_topic_0131145861_section1245611572597"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0046__en-us_topic_0131145861_p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
</div>
<div class="section" id="modelarts_03_0046__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0046__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_0044.html">Training Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink