forked from laiweijian4/doc-exports
525370b67d
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>
196 lines
18 KiB
HTML
196 lines
18 KiB
HTML
<a name="modelarts_03_0149"></a><a name="modelarts_03_0149"></a>
|
|
|
|
<h1 class="topictitle1">Querying Training Job Logs</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section59889949"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0149__en-us_topic_0188093645_p25674946">This API is used to query detailed information about training job logs by row.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section2138635"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0149__en-us_topic_0188093645_p37992218355">GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-log</p>
|
|
<div class="p" id="modelarts_03_0149__en-us_topic_0188093645_p65771147125313"><a href="#modelarts_03_0149__en-us_topic_0188093645_table4442765616454">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0149__en-us_topic_0188093645_table4442765616454"></a><a name="en-us_topic_0188093645_table4442765616454"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0149__en-us_topic_0188093645_table4442765616454" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="modelarts_03_0149__en-us_topic_0188093645_row1885755016454"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0149__en-us_topic_0188093645_p2131794716511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0149__en-us_topic_0188093645_p4903214216511">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_0149__en-us_topic_0188093645_p1218057416511">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_0149__en-us_topic_0188093645_p4710241816511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0149__en-us_topic_0188093645_row5911821816454"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p264845616511">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1319836116511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p6243435216511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p2401771416511">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>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row467320216454"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p861340516511">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p2659720516511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p689001016511">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p2121992316511">ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row2274948268"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p427412487612">version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p13953156365">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p162743482617">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1427434811615">Version ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0149__en-us_topic_0188093645_table105084321419" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="modelarts_03_0149__en-us_topic_0188093645_row1350973181417"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.4.2.5.1.1"><p id="modelarts_03_0149__en-us_topic_0188093645_p3509133131417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.4.2.5.1.2"><p id="modelarts_03_0149__en-us_topic_0188093645_p1350913101418">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.4.2.5.1.3"><p id="modelarts_03_0149__en-us_topic_0188093645_p1450916321417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.2.4.2.5.1.4"><p id="modelarts_03_0149__en-us_topic_0188093645_p1950910381414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0149__en-us_topic_0188093645_row165093319144"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p105093331418">base_line</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p150918301413">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p135096371416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1450919315144">Base line of the log, which is obtained from an API response. If the value is empty, the latest log is obtained.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row0509334144"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p185094316143">lines</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p750919311412">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1650914311146">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p175097318149">Length of the obtained log. The default value is 50 lines. The value range is [0, 500].</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row050919391411"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p850915331411">log_file</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p25095391418">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p16509538148">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p6509153191415">Name of the log file to be viewed. For details about how to obtain the log file name, see <a href="modelarts_03_0054.html">Obtaining the Name of a Training Job Log File</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row650910318144"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.4.2.5.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p950919311143">order</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1350914313142">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.4.2.5.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p9509163111418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.4.2.5.1.4 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1509736144">Log query direction</p>
|
|
<ul id="modelarts_03_0149__en-us_topic_0188093645_ul1550918312145"><li id="modelarts_03_0149__en-us_topic_0188093645_li1509539149"><strong id="modelarts_03_0149__en-us_topic_0188093645_b1620711013910">desc</strong>: Query next records.</li><li id="modelarts_03_0149__en-us_topic_0188093645_li750911351420"><strong id="modelarts_03_0149__en-us_topic_0188093645_b9262115103811">asc</strong>: Query previous records.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section14721183115213"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0149__en-us_topic_0188093645_p215516381222">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section15561295"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0149__en-us_topic_0188093645_p1422850741"><a href="#modelarts_03_0149__en-us_topic_0188093645_table1414514116749">Table 3</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0149__en-us_topic_0188093645_table1414514116749"></a><a name="en-us_topic_0188093645_table1414514116749"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0149__en-us_topic_0188093645_table1414514116749" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0149__en-us_topic_0188093645_row1296552316749"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0149__en-us_topic_0188093645_p452264431685">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0149__en-us_topic_0188093645_p424067391685">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0149__en-us_topic_0188093645_p123938441685">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0149__en-us_topic_0188093645_row379107356"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p3678195015417">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p367815017542">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p146788503545">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0149__en-us_topic_0188093645_p767865010549">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row95021353811"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p11679105018547">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1267985011549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p0679850175418">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="modelarts_03_0149__en-us_topic_0188093645_p19679165010545">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row1722835016749"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p66791450125415">content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p14679105018543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p26797507547">Content of the requested log</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row5468243216749"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p106791550185420">lines</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p19679185085415">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p166791150135420">Lines of the obtained logs</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row2034114592315"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p9679125012541">start_line</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p176791508545">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p4679145085412">Start position of the obtained log</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row655612121183"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p967995005417">end_line</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p176797504547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p168085014548">End position of the obtained log</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0149__en-us_topic_0188093645_row1269012524588"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0149__en-us_topic_0188093645_p1755631210811">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0149__en-us_topic_0188093645_p455691212818">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0149__en-us_topic_0188093645_p3556121216814">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section828415581838"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0149__en-us_topic_0188093645_p7208203917515">The following shows how to query the logs contained in <span class="filepath" id="modelarts_03_0149__en-us_topic_0188093645_filepath136125617525"><b>log1.log</b></span> of the job whose <span class="parmvalue" id="modelarts_03_0149__en-us_topic_0188093645_parmvalue512135635211"><b>job_id</b></span> is <strong id="modelarts_03_0149__en-us_topic_0188093645_b13121056135212">10</strong> and <span class="parmvalue" id="modelarts_03_0149__en-us_topic_0188093645_parmvalue17121956195211"><b>version_id</b></span> is <strong id="modelarts_03_0149__en-us_topic_0188093645_b712135616529">10</strong>.</p>
|
|
<ul id="modelarts_03_0149__en-us_topic_0188093645_ul1233813121945"><li id="modelarts_03_0149__en-us_topic_0188093645_li93381126418">Sample request<pre class="screen" id="modelarts_03_0149__en-us_topic_0188093645_screen3161113433711">GET https://endpoint/v1/{project_id}/training-jobs/10/versions/10/aom-log?log_file=log1.log&base_line= 1551252759254000002&lines=50&order=desc</pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0149__en-us_topic_0188093645_ul13567541132"><li id="modelarts_03_0149__en-us_topic_0188093645_li7639753">Successful sample response<pre class="screen" id="modelarts_03_0149__en-us_topic_0188093645_screen8413744143720">{
|
|
"is_success": true,
|
|
"start_line":1551252759254000002,
|
|
"content": "Log string",
|
|
"end_line": "1551252759254000003",
|
|
"lines": "1"
|
|
}</pre>
|
|
</li><li id="modelarts_03_0149__en-us_topic_0188093645_li69931349184">Failed sample response<pre class="screen" id="modelarts_03_0149__en-us_topic_0188093645_screen24001548379">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__en-us_topic_0188093645_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0149__en-us_topic_0188093645_p19942204915154">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0149__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0149__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>
|
|
|