vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0087.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

225 lines
20 KiB
HTML
Raw Blame History

<a name="modelarts_03_0087"></a><a name="modelarts_03_0087"></a>
<h1 class="topictitle1">Querying Service Monitoring Information</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section1543612115413"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0087__en-us_topic_0130048742_p2517918849">This API is used to query service monitoring information. </p>
</div>
<div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section181341535122619"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0087__en-us_topic_0130048742_p12213418185619">GET /v1/{project_id}/services/{service_id}/monitor</p>
<div class="p" id="modelarts_03_0087__en-us_topic_0130048742_p86385208570"><a href="#modelarts_03_0087__en-us_topic_0130048742_table10624434011">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0087__en-us_topic_0130048742_table10624434011"></a><a name="en-us_topic_0130048742_table10624434011"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0087__en-us_topic_0130048742_table10624434011" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0087__en-us_topic_0130048742_row13653412406"><th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0087__en-us_topic_0130048742_p8665404020">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0087__en-us_topic_0130048742_p46614184018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0087__en-us_topic_0130048742_p668154124018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0087__en-us_topic_0130048742_p469204194016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0087__en-us_topic_0130048742_row1797617864917"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p8780885181639">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p40163046181639">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p31981288181639">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0087__en-us_topic_0130048742_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>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row870174164011"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p372348400">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p19736411406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p174643403">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0087__en-us_topic_0130048742_p575194174011">Service ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0087__en-us_topic_0130048742_table118011654615" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0087__en-us_topic_0130048742_row128412615467"><th align="left" class="cellrowborder" valign="top" width="18.627450980392158%" id="mcps1.3.2.3.3.2.5.1.1"><p id="modelarts_03_0087__en-us_topic_0130048742_p198612613464">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.686274509803921%" id="mcps1.3.2.3.3.2.5.1.2"><p id="modelarts_03_0087__en-us_topic_0130048742_p488116104612">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.745098039215685%" id="mcps1.3.2.3.3.2.5.1.3"><p id="modelarts_03_0087__en-us_topic_0130048742_p5894684613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.94117647058824%" id="mcps1.3.2.3.3.2.5.1.4"><p id="modelarts_03_0087__en-us_topic_0130048742_p139246154610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0087__en-us_topic_0130048742_row17943614619"><td class="cellrowborder" valign="top" width="18.627450980392158%" headers="mcps1.3.2.3.3.2.5.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p19951767464">node_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.2.3.3.2.5.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1098196194611">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.745098039215685%" headers="mcps1.3.2.3.3.2.5.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p199917615466">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94117647058824%" headers="mcps1.3.2.3.3.2.5.1.4 "><p id="modelarts_03_0087__en-us_topic_0130048742_p181000684616">ID of the node to be queried. By default, all nodes are queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section71456147333"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0087__en-us_topic_0130048742_p363816016013">None</p>
</div>
<div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section54078976"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0087__en-us_topic_0130048742_p334315171906"><a href="#modelarts_03_0087__en-us_topic_0130048742_table413209485">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="modelarts_03_0087__en-us_topic_0130048742_table413209485"></a><a name="en-us_topic_0130048742_table413209485"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0087__en-us_topic_0130048742_table413209485" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0087__en-us_topic_0130048742_row461520144819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0087__en-us_topic_0130048742_p671720184814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0087__en-us_topic_0130048742_p41062004818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0087__en-us_topic_0130048742_p51317202481">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0087__en-us_topic_0130048742_row121442013482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1716122012489">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p418162011482">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1819420164816">Service ID</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row92052015484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p20221720114814">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1023220104819">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p825162013488">Service name</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row92632004815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p42818204484">monitors</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p731120134816"><strong id="modelarts_03_0087__en-us_topic_0130048742_b19496998816">monitor</strong> array corresponding to <strong id="modelarts_03_0087__en-us_topic_0130048742_b37955511581">infer_type</strong> of a service</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p83212019487">Monitoring details</p>
<ul id="modelarts_03_0087__en-us_topic_0130048742_ul68451277451"><li id="modelarts_03_0087__en-us_topic_0130048742_li178453278452">If <strong id="modelarts_03_0087__en-us_topic_0130048742_b65681961712">infer_type</strong> is set to <strong id="modelarts_03_0087__en-us_topic_0130048742_b135671931715">real-time</strong>, see <a href="#modelarts_03_0087__en-us_topic_0130048742_table974014115493">Table 4</a>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="modelarts_03_0087__en-us_topic_0130048742_table974014115493"></a><a name="en-us_topic_0130048742_table974014115493"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0087__en-us_topic_0130048742_table974014115493" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0087__en-us_topic_0130048742_b81785519115">monitor</strong> parameters of <strong id="modelarts_03_0087__en-us_topic_0130048742_b817820519116">real-time</strong></caption><thead align="left"><tr id="modelarts_03_0087__en-us_topic_0130048742_row9746151116491"><th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.4.2.3.2.4.1.1"><p id="modelarts_03_0087__en-us_topic_0130048742_p16747181134917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.4.2.3.2.4.1.2"><p id="modelarts_03_0087__en-us_topic_0130048742_p1374918110495">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.33663366336634%" id="mcps1.3.4.2.3.2.4.1.3"><p id="modelarts_03_0087__en-us_topic_0130048742_p12751411154913">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0087__en-us_topic_0130048742_row5753131154919"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p775414117493">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p7756151110496">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p7758101113496">Model ID</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row14758111124914"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p147601111496">model_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p14761111184916">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p10763151116498">Model name</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row47648112490"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p876541119491">model_version</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p137672011124919">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p476921114917">Model version</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row67698116499"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p127716113496">invocation_times</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p5773101184912">Long</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p14774131112495">Total number of model instance calls</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row19775911204916"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p19776711144916">failed_times</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p5780201174916">Long</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p2782311144916">Number of failed model instance calls</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row37831811204911"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p578561184910">cpu_core_usage</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p178731117493">Float</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p5789201117496">Number of used CPUs</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row77891011104917"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1479101124913">cpu_core_total</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1793111116493">Float</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p12795121154912">Total number of CPUs</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row12796131124912"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1579711144916">cpu_memory_usage</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p13799151174913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1580031124911">Used memory, in MB</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row8801161111494"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p3802111164916">cpu_memory_total</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p168041111104914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p680611184914">Total memory, in MB</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row11807121113499"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p4809121184912">gpu_usage</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p17810201194919">Float</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p198121011184910">Number used GPUs</p>
</td>
</tr>
<tr id="modelarts_03_0087__en-us_topic_0130048742_row1881341194918"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="modelarts_03_0087__en-us_topic_0130048742_p981510119492">gpu_total</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="modelarts_03_0087__en-us_topic_0130048742_p1481771144915">Float</p>
</td>
<td class="cellrowborder" valign="top" width="66.33663366336634%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="modelarts_03_0087__en-us_topic_0130048742_p281871154917">Total number of GPUs</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section1810193414711"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0087__en-us_topic_0130048742_p1626113524475">The following shows how to query the monitoring information about a real-time service.</p>
</div>
<ul id="modelarts_03_0087__en-us_topic_0130048742_ul11661134735818"><li id="modelarts_03_0087__en-us_topic_0130048742_li8663184755814">Sample request<pre class="screen" id="modelarts_03_0087__en-us_topic_0130048742_screen17210756125618">GET https://endpoint/v1/{project_id}/services/{service_id}/monitor</pre>
</li></ul>
<ul id="modelarts_03_0087__en-us_topic_0130048742_ul163453474715"><li id="modelarts_03_0087__en-us_topic_0130048742_li1533103454717">Sample response<pre class="screen" id="modelarts_03_0087__en-us_topic_0130048742_screen7636135570">{
"service_id": "xxx",
"service_name": "mnist",
"monitors":
[{
"model_id": "xxxx",
"model_name": "minst",
"model_version": "1.0.0",
"invocation_times": 50,
"failed_times": 1,
"cpu_core_usage": "2.4",
"cpu_core_total": "4",
"cpu_memory_usage": "2011",
"cpu_memory_total": "8192",
"gpu_usage": "0.6",
"gpu_total": "1"
} ]
}</pre>
</li></ul>
<div class="section" id="modelarts_03_0087__en-us_topic_0130048742_section16948739"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0087__en-us_topic_0130048742_p1731954913014">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_0087__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0087__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_0081.html">Service Management</a></div>
</div>
</div>
View Git Blame Copy Permalink