forked from docs/doc-exports
qiujiandong1
e9265fb6b0
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
433 lines
31 KiB
HTML
433 lines
31 KiB
HTML
<a name="ces_03_0073"></a><a name="ces_03_0073"></a>
|
|
|
|
<h1 class="topictitle1">Query Resource Groups</h1>
|
|
<div id="body1606895824429"><div class="section" id="ces_03_0073__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0073__p151864411282">This API is used to query all resource groups you created.</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0073__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0073__p565541016124">GET /V1.0/{project_id}/resource-groups</p>
|
|
<ul id="ces_03_0073__ul8883693"><li id="ces_03_0073__li33761356">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table31681753175455" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0073__row39882175175455"><th align="left" class="cellrowborder" valign="top" width="18.488151184881513%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="ces_03_0073__p9230722175455">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.078992100789922%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="ces_03_0073__p143555319611">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.798320167983203%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="ces_03_0073__p9490989175455">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.634536546345366%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="ces_03_0073__p30572649175455">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row60465501175455"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p65867442175455">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p936115316615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p33662608175455">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p42316702175455">Specifies the project ID.</p>
|
|
<p id="ces_03_0073__p763520422586">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
|
|
<p id="ces_03_0073__en-us_topic_0000001646899046_p18100524114814">Minimum: <strong id="ces_03_0073__b71804412543835">1</strong></p>
|
|
<p id="ces_03_0073__en-us_topic_0000001646899046_p81001524104817">Maximum: <strong id="ces_03_0073__b29946527183243">64</strong></p>
|
|
<p id="ces_03_0073__p4697184133915"><strong id="ces_03_0073__b60422133325040">Regular expression matching</strong>: ^[a-zA-Z0-9-]{1,64}$</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row1124612531976"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p153351659262">group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p203351359663">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p433565912611">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p14770145111014">Specifies the resource group, for example, <strong id="ces_03_0073__b18486311896">Resource-Group-ECS-01</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row186581855073"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p1633520592067">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p123351959269">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p433519598617">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p1770452109">Specifies the resource group ID, for example, <strong id="ces_03_0073__b17499136694">rg1603786526428bWbVmk4rP</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row53381181480"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p173362597612">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p1733610591065">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p20336175914619">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p5341164513409">Specifies the resource group status, which can be <strong id="ces_03_0073__b234154517407">health</strong>, <strong id="ces_03_0073__b12341194517401">unhealth</strong>, or <strong id="ces_03_0073__b12341144516407">no_alarm_rule</strong>.</p>
|
|
<ul id="ces_03_0073__ul28591556164019"><li id="ces_03_0073__li98581856144012"><strong id="ces_03_0073__b3858456114015">health</strong>: No alarms have been generated for the resource group.</li><li id="ces_03_0073__li17858656144016"><strong id="ces_03_0073__b485818567408">unhealth</strong>: An alarm or alarms have been generated for a resource or resources in the resource group.</li><li id="ces_03_0073__li1185995654019"><strong id="ces_03_0073__b1585975684019">no_alarm_rule</strong>: No alarm rules have been set for the resource group.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row4191511783"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p7336135918613">start</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p183367591065">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p1336559562">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p193361459562">Specifies the start value of pagination. The value is an integer. The default value is <strong id="ces_03_0073__b1517317271794">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row455919133815"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0073__p1336659265">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.078992100789922%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0073__p11336195917616">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.798320167983203%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0073__p1933665916616">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.634536546345366%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0073__p3336125911618">Specifies the maximum number of records that can be queried at a time. Supported range: <strong id="ces_03_0073__b1535392711197">1</strong> to <strong id="ces_03_0073__b15354927191919">100</strong> (default)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0073__ul52541973175457"><li id="ces_03_0073__li41462866">Example<pre class="screen" id="ces_03_0073__screen19889056194625">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0073__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0073__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0073__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0073__ul5769005"><li id="ces_03_0073__li27068104152742">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table42286344152742" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="ces_03_0073__row38095364152742"><th align="left" class="cellrowborder" valign="top" width="21.14%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="ces_03_0073__p65825661152742">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.53%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="ces_03_0073__p36622711152742">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.27%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="ces_03_0073__p159211336118">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.06%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="ces_03_0073__p13649609152742">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row48913836152742"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="ces_03_0073__p171102368127">resource_groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.53%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="ces_03_0073__p31101236181219">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.27%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="ces_03_0073__p211073617120">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="ces_03_0073__p11110736171210">Specifies information about one or more resource groups.</p>
|
|
<p id="ces_03_0073__p1053910552408">For details, see <a href="#ces_03_0073__table10571837131516">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row185671917132310"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="ces_03_0073__p7110123616124">meta_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.53%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="ces_03_0073__p11110236101217">MetaData object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.27%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="ces_03_0073__p1711011369126">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.06%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="ces_03_0073__p3110836161213">Specifies the number of metadata records in the query result.</p>
|
|
<p id="ces_03_0073__p5522125718402">For details, see <a href="#ces_03_0073__table7554143164419">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0073__table10571837131516"></a><a name="table10571837131516"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table10571837131516" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0073__b101399419134">resource_groups</strong> data structure description</caption><thead align="left"><tr id="ces_03_0073__row134453716156"><th align="left" class="cellrowborder" valign="top" width="21.14%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="ces_03_0073__p124463713153">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.659999999999998%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="ces_03_0073__p104453761519">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.190000000000001%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="ces_03_0073__p13733173811116">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.010000000000005%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="ces_03_0073__p74433718157">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row248153712151"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p817434710135">group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p317444781315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p19174947171315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p81741476134">Specifies the resource group name, for example, <strong id="ces_03_0073__b1255275612326">ResourceGroup-Test01</strong>. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row1748203712158"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p1917484791315">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p31741647201314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p21741847181315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p121741247161314">Specifies the resource group ID, for example, <strong id="ces_03_0073__b45805307337">rg1603786526428bWbVmk4rP</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row19488375152"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p12174947151318">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p1517415475133">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p71741947161317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p1617494718136">Specifies the time when the resource group was created. The value is a UNIX timestamp, in milliseconds. Example: <strong id="ces_03_0073__b18876133713336">1603819753000</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row136331810184214"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p078417225119">relation_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p106161559125115">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p778472205114">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p678520225120">Specifies the enterprise project IDs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row164351714164218"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p836402765215">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p536492725217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p10365102715214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p13935359153816">Specifies the method of adding or matching resources to a resource group.</p>
|
|
<p id="ces_03_0073__p196475464363">The value can be:</p>
|
|
<p id="ces_03_0073__p10814194915363"><strong id="ces_03_0073__b396176163918">EPS</strong>: matching resources by enterprise project.</p>
|
|
<p id="ces_03_0073__p95651455163618"><strong id="ces_03_0073__b96807811392">TAG</strong>: matching resources by tag.</p>
|
|
<p id="ces_03_0073__p5548103212376"><strong id="ces_03_0073__b8623171083918">NAME</strong>: matching resources by instance name.</p>
|
|
<p id="ces_03_0073__p5647171512388"><strong id="ces_03_0073__b1311215122394">COMB</strong>: matching resources by multiple criteria.</p>
|
|
<p id="ces_03_0073__p144255527373"><strong id="ces_03_0073__b10863113143918">Manual</strong>: add resources manually.</p>
|
|
<p id="ces_03_0073__p6951173017297">If the response parameter is empty, resources are manually added.</p>
|
|
<p id="ces_03_0073__p178631075513">Minimum length: 0 character</p>
|
|
<p id="ces_03_0073__p08611018558">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row6378212114211"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p179714280528">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p6399215102813">Array of Resource objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p10981728125216">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p1596783295416">Specifies information about one or more resources.</p>
|
|
<p id="ces_03_0073__p5967132135411">Array length: 0 to 20</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row67771619131312"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p71741447121314">instance_statistics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p51741747141315">InstanceStatistics object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p161750477134">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p14175174771316">Specifies the resource statistics in the resource group.</p>
|
|
<p id="ces_03_0073__p10351500417">For details, see <a href="#ces_03_0073__table19174559133918">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row19620229131"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p12175104718132">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p8175184715135">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p9175747111319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p17331533135014">Specifies the resource group status, which can be <strong id="ces_03_0073__b18653115918411">health</strong>, <strong id="ces_03_0073__b106551059124112">unhealth</strong>, or <strong id="ces_03_0073__b14657135984119">no_alarm_rule</strong>.</p>
|
|
<ul id="ces_03_0073__ul629775913500"><li id="ces_03_0073__li529715985011"><strong id="ces_03_0073__b82979597502">health</strong>: No alarms have been generated for the resource group.</li><li id="ces_03_0073__li172971559165011"><strong id="ces_03_0073__b2297155917503">unhealth</strong>: An alarm or alarms have been generated for a resource or resources in the resource group.</li><li id="ces_03_0073__li132972595500"><strong id="ces_03_0073__b12971959125012">no_alarm_rule</strong>: No alarm rules have been set for the resource group.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row473417245131"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="ces_03_0073__p717504716133">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.659999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="ces_03_0073__p13175247191319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.190000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="ces_03_0073__p1717554701318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="ces_03_0073__p21751647101320">Specifies the enterprise project associated with the resource group. The default value <strong id="ces_03_0073__b1793163313513">0</strong> indicates enterprise project <strong id="ces_03_0073__b679313325119">default.</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0073__table19174559133918"></a><a name="table19174559133918"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table19174559133918" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0073__b667620358512">instance_statistics</strong> data structure description</caption><thead align="left"><tr id="ces_03_0073__row10174145923910"><th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="ces_03_0073__p117455973917">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.89%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="ces_03_0073__p21751659193910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.209999999999999%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="ces_03_0073__p103541842181111">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.91%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="ces_03_0073__p317575993911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row1017713594391"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="ces_03_0073__p0906115191916">unhealth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="ces_03_0073__p8906055199">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="ces_03_0073__p1290725131914">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.91%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="ces_03_0073__p10907175141910">Specifies the number of resources in the <strong id="ces_03_0073__b2513173517525">Alarm</strong> state in the resource group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row717815917396"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="ces_03_0073__p2907959192">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="ces_03_0073__p0907175181919">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="ces_03_0073__p17907955198">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.91%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="ces_03_0073__p189078531913">Specifies the total number of resources in the resource group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row692345512184"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="ces_03_0073__p590713501911">type_statistics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="ces_03_0073__p39072052194">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="ces_03_0073__p14907353197">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.91%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="ces_03_0073__p1907852194">Specifies the total number of resource types in the resource group. For example, if ECS, EIP and bandwidth are added to the resource group, the <strong id="ces_03_0073__b461512785914">type_statistics</strong> value is <strong id="ces_03_0073__b4247101265911">2</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0073__table7554143164419"></a><a name="table7554143164419"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table7554143164419" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0073__b49492685510">meta_data</strong> data structure description</caption><thead align="left"><tr id="ces_03_0073__row1555516374419"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.1.4.2.5.1.1"><p id="ces_03_0073__p6555193144417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.4%" id="mcps1.3.4.2.1.4.2.5.1.2"><p id="ces_03_0073__p125551734448">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.69%" id="mcps1.3.4.2.1.4.2.5.1.3"><p id="ces_03_0073__p111001346111115">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.91%" id="mcps1.3.4.2.1.4.2.5.1.4"><p id="ces_03_0073__p1755533204413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row19559235443"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="ces_03_0073__p546391862312">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.4%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="ces_03_0073__p144631718152312">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="ces_03_0073__p91001467119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.91%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="ces_03_0073__p19463718162319">Specifies the total number of query results.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="ces_03_0073__ul34750592184830"><li id="ces_03_0073__li44319877184830">Example response<pre class="screen" id="ces_03_0073__screen4738031718551">{
|
|
"resource_groups": [
|
|
{
|
|
"group_name": "ResourceGroup-Test01",
|
|
"create_time": 1606374365000,
|
|
"group_id": "rg16063743652226ew93e64p",
|
|
"relation_ids": ["0"],
|
|
"instance_statistics": {
|
|
"unhealth": 2,
|
|
"total": 10,
|
|
"type_statistics": 1
|
|
},
|
|
"status": "unhealth",
|
|
"enterprise_project_id": "0",
|
|
"type": "TAG",
|
|
"resources": []
|
|
},
|
|
{
|
|
"group_name": "RS",
|
|
"create_time": 1606327955000,
|
|
"group_id": "rg1606327955657LRj1lrE4y",
|
|
"relation_ids": ["0"],
|
|
"instance_statistics": {
|
|
"unhealth": 0,
|
|
"total": 2,
|
|
"type_statistics": 1
|
|
},
|
|
"status": "no_alarm_rule",
|
|
"enterprise_project_id": "0",
|
|
"type": "TAG",
|
|
"resources": []
|
|
},
|
|
{
|
|
"group_name": "RS",
|
|
"create_time": 1606327947000,
|
|
"group_id": "rg1606327947514v9OWqAD3N",
|
|
"relation_ids": ["0"],
|
|
"instance_statistics": {
|
|
"unhealth": 0,
|
|
"total": 2,
|
|
"type_statistics": 1
|
|
},
|
|
"status": "no_alarm_rule",
|
|
"enterprise_project_id": "0",
|
|
"type": "TAG",
|
|
"resources": []
|
|
},
|
|
{
|
|
"group_name": "RS",
|
|
"create_time": 1606327946000,
|
|
"group_id": "rg1606327946625PYogr059N",
|
|
"relation_ids": ["0"],
|
|
"instance_statistics": {
|
|
"unhealth": 0,
|
|
"total": 2,
|
|
"type_statistics": 1
|
|
},
|
|
"status": "no_alarm_rule",
|
|
"enterprise_project_id": "0",
|
|
"type": "TAG",
|
|
"resources": []
|
|
},
|
|
{
|
|
"group_name": "ResourceGroupCorrect_2",
|
|
"create_time": 1606325669000,
|
|
"group_id": "rg1606325669900Rk4eKkLMZ",
|
|
"relation_ids": ["0"],
|
|
"instance_statistics": {
|
|
"unhealth": 0,
|
|
"total": 1,
|
|
"type_statistics": 1
|
|
},
|
|
"status": "no_alarm_rule",
|
|
"enterprise_project_id": "0",
|
|
"type": "TAG",
|
|
"resources": []
|
|
}
|
|
],
|
|
"meta_data": {
|
|
"total": 5
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0073__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0073__ul20226985"><li id="ces_03_0073__li47825138">Normal<p id="ces_03_0073__p27773061"><a name="ces_03_0073__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0073__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0073__table9852173623812" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0073__row985213612382"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0073__p1849030182924">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0073__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0073__row4852193611387"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p581987519168">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row188531636193819"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p2691669168">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row118531636123816"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p563264059168">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row4853436123812"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p355199299168">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row1285303673812"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p630127129168">429 Too Many Requests</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row1853336203811"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p537873819168">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0073__row38537365385"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0073__p298930079168">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0073__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0073__section121612204463"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0073__en-us_topic_0171212585_p91851023153416">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0067.html">Resource Groups</a></div>
|
|
</div>
|
|
</div>
|
|
|