yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
main
doc-exports/docs/modelarts/api-ref/ShowPoolStatistics.html
Wuwan, Qi e733dda338 ModelArts API 25.3.0 20250820 version 
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>
2025-08-25 07:31:07 +00:00

224 lines
16 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000002340898542"></a><a name="EN-US_TOPIC_0000002340898542"></a>
<h1 class="topictitle1">Obtaining Resource Pool Statistics</h1>
<div id="body1708331107508"><div class="section" id="EN-US_TOPIC_0000002340898542__section15900161981916"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340898542__p1090031914197">This API is used to obtain resource pool statistics.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002340898542__p1390119197196">GET /v2/{project_id}/statistics/pools</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__table4902191931912" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898542__row169011419181916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002340898542__p119021919121911">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_0000002340898542__p59021319121914">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_0000002340898542__p109031819121919">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_0000002340898542__p149031819121920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row13902619111915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002340898542__p690391913198">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_0000002340898542__p16903191941919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002340898542__p17904119151919">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002340898542__p189041619191915">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_0000002340898542__table16905719111910" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898542__row690451915190"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0000002340898542__p79051193195">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_0000002340898542__p19905319161913">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_0000002340898542__p15906151971911">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_0000002340898542__p12906141920192">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row1390581931916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1906171910191">workspaceId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002340898542__p129061190196">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002340898542__p14906141971919">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002340898542__p1890716197194">Workspace ID. The default value is <strong id="EN-US_TOPIC_0000002340898542__b1890711911916">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section129073191194"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002340898542__p5907111941919">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section1490741920194"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002340898542__p1390821911917"><strong id="EN-US_TOPIC_0000002340898542__b390813196195">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__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_0000002340898542__row790817199191"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002340898542__p290991917193">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002340898542__p29091619101918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002340898542__p119090197193">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row1990861910197"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1691091941912">statistics</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p1391051917191"><a href="#EN-US_TOPIC_0000002340898542__response_PoolStatisticsItem">PoolStatisticsItem</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p139101193193">Resource pool statistics</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row1490851916195"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1091041901912">operationTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p89101319141912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p8911131913197">Statistics time</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340898542__response_PoolStatisticsItem"></a><a name="response_PoolStatisticsItem"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__response_PoolStatisticsItem" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PoolStatisticsItem</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898542__row1911151931913"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002340898542__p14912101910197">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000002340898542__p8912619121919">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000002340898542__p18912619141910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row179111519131913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p18912319171916">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p791219195195"><a href="#EN-US_TOPIC_0000002340898542__response_PoolStatisticsStatus">PoolStatisticsStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p1591211918192">Statistics about resource pools in different statuses.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340898542__response_PoolStatisticsStatus"></a><a name="response_PoolStatisticsStatus"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__response_PoolStatisticsStatus" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PoolStatisticsStatus</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898542__row89131419161910"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002340898542__p8914181918191">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000002340898542__p1691441915196">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000002340898542__p17914131981910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row39131719141919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p18915219151912">creating</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p491501918194">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p139151719121915">Number of resource pools that are being created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row29131119201915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p191510197192">created</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p2915919171916">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p1916219111910">Number of created resource pools.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row1291381991917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1291631918198">failed</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p2916161913199">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p691661910195">Number of resource pools that failed to be created in the last three days. The maximum value is <strong id="EN-US_TOPIC_0000002340898542__b139161319101917">500</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row149135191193"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1691641912191">pending</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p10917161991915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p18917819111911">Number of resource pools in the waiting status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000002340898542__p15917111981914"><strong id="EN-US_TOPIC_0000002340898542__b8917121920193">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__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_0000002340898542__row39182019111919"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="EN-US_TOPIC_0000002340898542__p2918141920193">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="EN-US_TOPIC_0000002340898542__p2919619151911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="EN-US_TOPIC_0000002340898542__p179191197192">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row16918219191914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p1919151918194">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p1592041951917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p129201819191916">Error code.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row591821918196"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898542__p3920161915197">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898542__p79203196199">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898542__p092011931914">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section292061917190"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002340898542__p1592011191193">Obtain resource pool statistics.</p>
<pre class="screen" id="EN-US_TOPIC_0000002340898542__screen139201719101918">GET https://{endpoint}/v2/{project_id}/statistics/pools</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section1892151971915"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002340898542__p7921161913191"><strong id="EN-US_TOPIC_0000002340898542__b69217192197">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002340898542__p109211019161912">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002340898542__screen1492131921920">{
"statistics" : {
"status" : {
"created" : 9,
"creating" : 0,
"deleting" : 1,
"failed" : 0,
"pending" : 0
}
},
"operationTime" : "2025-03-27 11:48:55.446172146 +0000 UTC"
}</pre>
<p id="EN-US_TOPIC_0000002340898542__p10922181951919"><strong id="EN-US_TOPIC_0000002340898542__b3922111912192">Status code: 500</strong></p>
<p id="EN-US_TOPIC_0000002340898542__p692215194191">Internal error</p>
<pre class="screen" id="EN-US_TOPIC_0000002340898542__screen10923319171918">{
"error_code" : "ModelArts.50005000",
"error_msg" : "internal error"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section17923111981914"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898542__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002340898542__row2092461916197"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002340898542__p1924131921911">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_0000002340898542__p15925151910195">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898542__row89241419161915"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002340898542__p16925201931916">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002340898542__p492561918190">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898542__row139241319181916"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002340898542__p189251019151912">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002340898542__p1792511921915">Internal error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898542__section8925151912197"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002340898542__p1592621918199">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>
View Git Blame Copy Permalink