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>
283 lines
24 KiB
HTML
283 lines
24 KiB
HTML
<a name="EN-US_TOPIC_0000001909747396"></a><a name="EN-US_TOPIC_0000001909747396"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Training Job List</h1>
|
|
<div id="body1536889940350"><div class="section" id="EN-US_TOPIC_0000001909747396__section528664"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909747396__p29722048">This API is used to obtain the created training jobs that meet the search criteria.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section4757982"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909747396__p0218181715712">GET /v1/{project_id}/training-jobs</p>
|
|
<div class="p" id="EN-US_TOPIC_0000001909747396__p10971184713425"><a href="#EN-US_TOPIC_0000001909747396__table16518993181628">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747396__table16518993181628"></a><a name="table16518993181628"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747396__table16518993181628" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747396__row41524868181628"><th align="left" class="cellrowborder" valign="top" width="17.580000000000002%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909747396__p30350749181639">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909747396__p42491604181639">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.540000000000001%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909747396__p19267891181639">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.21%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909747396__p17195363181639">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747396__row6770181628"><td class="cellrowborder" valign="top" width="17.580000000000002%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p8780885181639">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p40163046181639">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.540000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p31981288181639">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.21%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p40347522181639">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_0000001909747396__table166417321355" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747396__row46411832956"><th align="left" class="cellrowborder" valign="top" width="17.57%" id="mcps1.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0000001909747396__p126419324510">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.78%" id="mcps1.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0000001909747396__p186427321353">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.86%" id="mcps1.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0000001909747396__p186427326517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.790000000000006%" id="mcps1.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0000001909747396__p364217320515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747396__row76421632158"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p196428322515">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p1164219326511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p20642232953">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p196421332855">Job status. By default, all job statuses are returned. For example, to obtain failed jobs, set the value of <strong id="EN-US_TOPIC_0000001909747396__b66214111737">status</strong> to <strong id="EN-US_TOPIC_0000001909747396__b4167271953">3</strong>, <strong id="EN-US_TOPIC_0000001909747396__b207919291355">5</strong>, <strong id="EN-US_TOPIC_0000001909747396__b132823116520">6</strong>, or <strong id="EN-US_TOPIC_0000001909747396__b1512511332518">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_0000001909747396__row06428320515"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p764213212519">per_page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p9642113213516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p10642143215519">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p464215323515">Number of jobs displayed on each page. The value range is [1, 1000]. Default value: <strong id="EN-US_TOPIC_0000001909747396__b83789561675">10</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row86424321853"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p16642173211513">page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p864203217511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p164215321511">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p46425321550">Index of the page to be queried. Default value: <strong id="EN-US_TOPIC_0000001909747396__b10206143413914">1</strong> The value range is [1, 65535].</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row564215324511"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p1164210326519">sortBy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p66421332855">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p96424322510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p864216326516">Sorting mode of the query. The value can be <strong id="EN-US_TOPIC_0000001909747396__b1161419179111">job_name</strong>, <strong id="EN-US_TOPIC_0000001909747396__b17504920161115">job_desc</strong>, <strong id="EN-US_TOPIC_0000001909747396__b1581112620111">status</strong>, <strong id="EN-US_TOPIC_0000001909747396__b13973112817114">duration</strong>, <strong id="EN-US_TOPIC_0000001909747396__b16348183313110">version_count</strong>, or <strong id="EN-US_TOPIC_0000001909747396__b6426153711114">create_time</strong>. Default value: <strong id="EN-US_TOPIC_0000001909747396__b19571468110">job_name</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row1464214323511"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p2064273214515">order</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p106425323519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p176428321853">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p1964210324515">Sorting order. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001909747396__ul19642632451"><li id="EN-US_TOPIC_0000001909747396__li18642173219516"><span class="parmvalue" id="EN-US_TOPIC_0000001909747396__parmvalue153636402291257"><b>asc</b></span>: ascending order. It is the default value.</li><li id="EN-US_TOPIC_0000001909747396__li13642532558"><span class="parmvalue" id="EN-US_TOPIC_0000001909747396__parmvalue185517008691327"><b>desc</b></span>: descending order</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row8642183214519"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p196423321753">search_content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p064218329520">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p564214329516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__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="EN-US_TOPIC_0000001909747396__row36428327510"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747396__p96428326511">workspace_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.78%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747396__p864219321452">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747396__p764218321058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.790000000000006%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747396__p664214327510">Workspace where a job resides. Default value: <strong id="EN-US_TOPIC_0000001909747396__b10528540203418">0</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section17382173235414"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909747396__p11333135175510">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section46017476"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909747396__p15979103725811"><a href="#EN-US_TOPIC_0000001909747396__table31621671103510">Table 3</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747396__table31621671103510"></a><a name="table31621671103510"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747396__table31621671103510" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747396__row43014294103510"><th align="left" class="cellrowborder" valign="top" width="17.121712171217123%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909747396__p27237124103529">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.34133413341334%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909747396__p58976351103529">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.53695369536955%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909747396__p12355133103529">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747396__row6154121019310"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row197335051410"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p16741250101412">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p167419502147">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p06401316154">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909747396__p5642163131513">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row16193448103510"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p21522350103529">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p11090557103529">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p1251312531679">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_0000001909747396__p25919895103529">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row45611722103510"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p11027791103529">job_total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p9983934103529">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p3392343103529">Total number of created jobs</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row64404474103510"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p57099024103529">job_count_limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p25018653103529">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p13245051103529">Number of training jobs that can be created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row49183900103510"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p59075084103529">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p37936844103529"><strong id="EN-US_TOPIC_0000001909747396__b1435521102311">jobs</strong> array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p52985513103529">Attributes of a training job. For details, see <a href="#EN-US_TOPIC_0000001909747396__table3971109103614">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row1282745719345"><td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p148277570341">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34133413341334%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p682715793413">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.53695369536955%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p1782745715344">Maximum number of training jobs</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747396__table3971109103614"></a><a name="table3971109103614"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747396__table3971109103614" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001909747396__b1965692753120">jobs</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747396__row7802134103614"><th align="left" class="cellrowborder" valign="top" width="17.1%" id="mcps1.3.4.2.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909747396__p3311592314323">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.51%" id="mcps1.3.4.2.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909747396__p6514409514323">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.39%" id="mcps1.3.4.2.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909747396__p4218030314323">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747396__row5535123419151"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p15535183415158">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p11536103420154">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p135361334151513">ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row7417784103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p5512274814323">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p3575764214323">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p1068790014323">Name of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row5907113192214"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p1909739228">version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p6909231225">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p1682219211685">Version ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row36417840103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p6057598714323">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p770788014323">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__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="EN-US_TOPIC_0000001909747396__row50389554103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p2562267414323">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p152021491810">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p266431714323">Timestamp when a training job is created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row57875733103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p6323926614323">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p2210695614323">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p4583303914323">Training job running duration, in milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row14074438103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p5918019514323">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p2886647314323">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p5648301314323">Description of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747396__row30554942103614"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747396__p3838291414323">version_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.51%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747396__p2200835214323">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.39%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747396__p86334528223">Number of versions of a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section16157163552319"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909747396__p139172385230">The following shows how to obtain training jobs in the <strong id="EN-US_TOPIC_0000001909747396__b185038614018">7</strong> state and with name containing <strong id="EN-US_TOPIC_0000001909747396__b19503176505">job</strong> on the first page. Each page displays 10 records sorted by <span class="parmvalue" id="EN-US_TOPIC_0000001909747396__parmvalue135031869017"><b>job_name</b></span> in ascending order.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909747396__screen11441354192319">GET https://endpoint/v1/{project_id}/training-jobs?status=7&per_page=10&page=1&sortBy=job_name&order=asc&search_content=job</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section818145122420"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909747396__ul16178101762418"><li id="EN-US_TOPIC_0000001909747396__li1517810172249">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909747396__screen121784172249">{
|
|
"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="EN-US_TOPIC_0000001909747396__li117971715243">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909747396__screen617914179249">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747396__section1245611572597"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909747396__p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</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>
|
|
|