forked from docs/doc-exports
175 lines
16 KiB
HTML
175 lines
16 KiB
HTML
<a name="modelarts_03_0073"></a><a name="modelarts_03_0073"></a>
|
|
|
|
<h1 class="topictitle1">Querying Job Engine Specifications</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section762414021714"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0073__en-us_topic_0131307648_p107017405712">This API is used to query the engine type and version of a specified job.</p>
|
|
<p id="modelarts_03_0073__en-us_topic_0131307648_p96262409173">You must specify the engine specifications when creating a training job or an inference job.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section2612026995423"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0073__en-us_topic_0131307648_p1590062181912">GET /v1/{project_id}/job/ai-engines</p>
|
|
<div class="p" id="modelarts_03_0073__en-us_topic_0131307648_p7629171714913"><a href="#modelarts_03_0073__en-us_topic_0131307648_table6017292495443">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0073__en-us_topic_0131307648_table6017292495443"></a><a name="en-us_topic_0131307648_table6017292495443"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0073__en-us_topic_0131307648_table6017292495443" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0073__en-us_topic_0131307648_row1281400895443"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0073__en-us_topic_0131307648_p6412281495455">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0073__en-us_topic_0131307648_p2656546695455">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0073__en-us_topic_0131307648_p431917195455">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0073__en-us_topic_0131307648_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0073__en-us_topic_0131307648_row1453354395443"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p6037999295455">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p5894118795455">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p950681895455">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0073__en-us_topic_0131307648_p3185478295455">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0073__en-us_topic_0131307648_table2918868102420" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0073__en-us_topic_0131307648_row46282814102420"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.2.3.3.2.5.1.1"><p id="modelarts_03_0073__en-us_topic_0131307648_p58767362102449">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.2.3.3.2.5.1.2"><p id="modelarts_03_0073__en-us_topic_0131307648_p62535864102449">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.2.3.3.2.5.1.3"><p id="modelarts_03_0073__en-us_topic_0131307648_p32240260102449">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.2.3.3.2.5.1.4"><p id="modelarts_03_0073__en-us_topic_0131307648_p144485553408">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0073__en-us_topic_0131307648_row55399715102420"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.3.3.2.5.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p9887341993">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.3.3.2.5.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p1414513610711">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.2.3.3.2.5.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p40637799102449">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.2.3.3.2.5.1.4 "><p id="modelarts_03_0073__en-us_topic_0131307648_p3327413102449">Job type. The value can be <span class="parmvalue" id="modelarts_03_0073__en-us_topic_0131307648_parmvalue12237105013511"><b>train</b></span> or <span class="parmvalue" id="modelarts_03_0073__en-us_topic_0131307648_parmvalue14242450453"><b>inference</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section25359586"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0073__en-us_topic_0131307648_p67971134191010">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section26909689"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0073__en-us_topic_0131307648_p139387120137"><a href="#modelarts_03_0073__en-us_topic_0131307648_table41713500151328">Table 3</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0073__en-us_topic_0131307648_table41713500151328"></a><a name="en-us_topic_0131307648_table41713500151328"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0073__en-us_topic_0131307648_table41713500151328" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0073__en-us_topic_0131307648_row29711324151328"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0073__en-us_topic_0131307648_p40127207151340">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0073__en-us_topic_0131307648_p6534128151340">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.65656565656566%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0073__en-us_topic_0131307648_p1887216884120">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0073__en-us_topic_0131307648_row8430194841220"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.65656565656566%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row14621155613184"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p1362145621819">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p1462165611184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.65656565656566%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p1648717451920">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0073__en-us_topic_0131307648_p154871644191">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row33778427151328"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p22897743151340">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p42454511151340">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.65656565656566%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p16263356151340">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="modelarts_03_0073__en-us_topic_0131307648_p42263441151340">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row2204993151328"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p61422889151340">engines</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p6849702151340"><strong id="modelarts_03_0073__en-us_topic_0131307648_b18985924274">engines</strong> array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.65656565656566%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p17954975151340">List of engine specifications attributes. For details, see <a href="#modelarts_03_0073__en-us_topic_0131307648_table21589744151355">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0073__en-us_topic_0131307648_table21589744151355"></a><a name="en-us_topic_0131307648_table21589744151355"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0073__en-us_topic_0131307648_table21589744151355" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0073__en-us_topic_0131307648_b191341421111511">engines</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0073__en-us_topic_0131307648_row51416725151355"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.4.1.1"><p id="modelarts_03_0073__en-us_topic_0131307648_p768308151421">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.3.2.4.1.2"><p id="modelarts_03_0073__en-us_topic_0131307648_p62232959151421">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.3.2.4.1.3"><p id="modelarts_03_0073__en-us_topic_0131307648_p9159121112412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0073__en-us_topic_0131307648_row41135235151355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p19028196151421">engine_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p64888930151421">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p21511952151421">Engine type of a training job</p>
|
|
<ul id="modelarts_03_0073__en-us_topic_0131307648_ul59389840151421"><li id="modelarts_03_0073__en-us_topic_0131307648_li64746518151421">1: TensorFlow</li><li id="modelarts_03_0073__en-us_topic_0131307648_li54614273016">5: Spark_MLlib</li><li id="modelarts_03_0073__en-us_topic_0131307648_li685943019335">6: Scikit Learn</li><li id="modelarts_03_0073__en-us_topic_0131307648_li1534195211305">9: XGBoost-Sklearn</li><li id="modelarts_03_0073__en-us_topic_0131307648_li17201928202913">10: PyTorch</li><li id="modelarts_03_0073__en-us_topic_0131307648_li6943104033214">17: MindSpore-GPU</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row62760482151355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p2798668151421">engine_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p25365580151421">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p41346117151421">ID of the engine selected for a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row5169432151355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p9439438151421">engine_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p26396986151421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p57781147151421">Name of the engine selected for a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0073__en-us_topic_0131307648_row47607587151355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0073__en-us_topic_0131307648_p45199142151421">engine_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0073__en-us_topic_0131307648_p37251898151421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0073__en-us_topic_0131307648_p64613725151421">Version of the engine selected for a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section11588124321115"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0073__en-us_topic_0131307648_p323215391124">The following shows how to query the engine specifications of a training job.</p>
|
|
<ul id="modelarts_03_0073__en-us_topic_0131307648_ul12112185216114"><li id="modelarts_03_0073__en-us_topic_0131307648_li611275214117">Sample request<pre class="screen" id="modelarts_03_0073__en-us_topic_0131307648_screen447918367190">GET https://endpoint/v1/{project_id}/job/ai-engines?job_type=train</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="modelarts_03_0073__en-us_topic_0131307648_ul79925012128"><li id="modelarts_03_0073__en-us_topic_0131307648_li43966249">Successful sample response<pre class="screen" id="modelarts_03_0073__en-us_topic_0131307648_screen947084614191">{
|
|
"is_success": true,
|
|
"engines": [
|
|
{
|
|
"engine_type": 1,
|
|
"engine_name": "TensorFlow",
|
|
"engine_id": 1,
|
|
"engine_version": "TF-1.4.0-python2.7"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li><li id="modelarts_03_0073__en-us_topic_0131307648_li954516463015">Failed sample response<pre class="screen" id="modelarts_03_0073__en-us_topic_0131307648_screen209379564195">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0073__en-us_topic_0131307648_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0073__en-us_topic_0131307648_p471814329176">For details about the status code, see <a href="modelarts_03_0094.html#modelarts_03_0094__en-us_topic_0132773864_table1450010510213">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0073__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0073__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_0071.html">Resource and Engine Specifications</a></div>
|
|
</div>
|
|
</div>
|
|
|