forked from docs/doc-exports
Wuwan, Qi
f81ead2467
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>
218 lines
16 KiB
HTML
218 lines
16 KiB
HTML
<a name="EN-US_TOPIC_0000002044058296"></a><a name="EN-US_TOPIC_0000002044058296"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Resource Pool Statistics</h1>
|
|
<div id="body123712263552"><div class="section" id="EN-US_TOPIC_0000002044058296__section18371526125512"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002044058296__p137252675520">This API is used to obtain resource pool statistics.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section937382605510"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002044058296__p1237342655510">GET /v2/{project_id}/statistics/pools</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__table637592611558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row18375122625520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002044058296__p7376326185510">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000002044058296__p3376126125515">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000002044058296__p33771326155519">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000002044058296__p4377192615517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row19375826105517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002044058296__p337782611556">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002044058296__p537892613555">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002044058296__p1837812665516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002044058296__p4378626175515">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__table1937919269558" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row137972625518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0000002044058296__p23801226145511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0000002044058296__p2038042619551">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0000002044058296__p183803264551">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0000002044058296__p33811526145517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row123796266552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002044058296__p5381142618557">workspaceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002044058296__p638292612556">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002044058296__p173828261558">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002044058296__p10382192615558">Workspace. The default value is <strong id="EN-US_TOPIC_0000002044058296__b938212263557">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section19383192613553"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002044058296__p15383172685514">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section15384102665511"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002044058296__p5384102655512"><strong id="EN-US_TOPIC_0000002044058296__b1738422612558">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__response_PoolStatistics" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row3385102655520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002044058296__p17410142615558">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002044058296__p18410152645510">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002044058296__p12410122615556">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row7385172618559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p194101926195518">statistics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p194116264555"><a href="#EN-US_TOPIC_0000002044058296__response_statistics">statistics</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p54112260556">Resource pool statistics</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002044058296__row33851326125510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p11411152615512">operationTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p4412526105512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p6413162685519">Statistics time</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002044058296__response_statistics"></a><a name="response_statistics"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__response_statistics" frame="border" border="1" rules="all"><caption><b>Table 4 </b>statistics</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row64141326185515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002044058296__p17415102675515">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000002044058296__p64152026115513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000002044058296__p54151026115515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row1741419262559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p44151926195516">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p441642655514"><a href="#EN-US_TOPIC_0000002044058296__response_status">status</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p1441652616558">Statistics about resource pools in different statuses</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002044058296__response_status"></a><a name="response_status"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__response_status" frame="border" border="1" rules="all"><caption><b>Table 5 </b>status</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row1141719262551"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002044058296__p114183266553">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000002044058296__p341962614557">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000002044058296__p64191826135513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row7417226175515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p84191226145513">creating</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p114194268550">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p342014269556">Number of resource pools that are being created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002044058296__row12417192645514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p54201926195515">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p342012265555">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p1942012612551">Number of created resource pools</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002044058296__row8417202612554"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p9421202625515">failed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p2421152612556">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p7422026145516">Number of resource pools that failed to be created in the last three days. The maximum value is <strong id="EN-US_TOPIC_0000002044058296__b9422726185514">500</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0000002044058296__p1642572645517"><strong id="EN-US_TOPIC_0000002044058296__b442517264559">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row3426132645510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="EN-US_TOPIC_0000002044058296__p15427526115512">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="EN-US_TOPIC_0000002044058296__p1427826115511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="EN-US_TOPIC_0000002044058296__p04281126165512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row0426172625515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p174284263554">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p1942842695512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p144281269552">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002044058296__row164261126175511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002044058296__p1842992613555">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002044058296__p12430226195514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002044058296__p13430132645517">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section184301626155514"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002044058296__p20430142616555">Obtaining the monitored information of a resource pool</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002044058296__screen24312263553">GET https://{endpoint}/v2/{project_id}/pools
|
|
|
|
{ }</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section11431192665511"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002044058296__p4432426105511"><strong id="EN-US_TOPIC_0000002044058296__b4432152620553">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000002044058296__p1143218268557">OK</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002044058296__screen17432132612552">{
|
|
"statistics" : {
|
|
"status" : {
|
|
"created" : 3,
|
|
"creating" : 0,
|
|
"failed" : 1,
|
|
"pending" : 0
|
|
}
|
|
},
|
|
"operationTime" : "2022-12-05 11:15:59.329633162 +0000 UTC"
|
|
}</pre>
|
|
<p id="EN-US_TOPIC_0000002044058296__p143462613556"><strong id="EN-US_TOPIC_0000002044058296__b3434326155512">Status code: 500</strong></p>
|
|
<p id="EN-US_TOPIC_0000002044058296__p134345266555">Internal error</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002044058296__screen20434162635518">{
|
|
"error_code" : "ModelArts.50005000",
|
|
"error_msg" : "internal error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section16435202615559"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002044058296__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002044058296__row11436102616555"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002044058296__p9436132613552">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000002044058296__p14437192610559">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002044058296__row1436326185514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002044058296__p94379266551">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002044058296__p1343720268553">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002044058296__row13436142612557"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002044058296__p1743711267557">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002044058296__p14388267555">Internal error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002044058296__section14381426125515"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002044058296__p243822615555">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="pools_management.html">Resource Pool Management</a></div>
|
|
</div>
|
|
</div>
|
|
|