yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/ucs/api-ref/ListClusterGroup.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version 
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2026-02-23 09:12:31 +00:00

428 lines
29 KiB
HTML
Raw Blame History

<a name="ListClusterGroup"></a><a name="ListClusterGroup"></a>
<h1 class="topictitle1">Obtaining the Fleet List</h1>
<div id="body12434172321717"><div class="section" id="ListClusterGroup__section343413237179"><h4 class="sectiontitle">Function</h4><p id="ListClusterGroup__p843472321720">This API is used to obtain the fleet list.</p>
</div>
<div class="section" id="ListClusterGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ListClusterGroup__p15434023161712">GET /v1/clustergroups</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__table1043542313172" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="ListClusterGroup__row1043512316173"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListClusterGroup__p10436192361714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListClusterGroup__p1943662301711">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListClusterGroup__p9436423111718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListClusterGroup__p14361023161712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row15435102361717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListClusterGroup__p843662311713">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListClusterGroup__p7436123141716">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListClusterGroup__p19436142312174">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListClusterGroup__p1243732317179">The number of records allowed on each page when the list is queried by page. The default value is <strong id="ListClusterGroup__b16221485684927">-1</strong>.</p>
</td>
</tr>
<tr id="ListClusterGroup__row443552318176"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListClusterGroup__p34376238178">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListClusterGroup__p9437123131711">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListClusterGroup__p1743715232172">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListClusterGroup__p1343772311173">Start offset when the list is queried by page. The default value is <strong id="ListClusterGroup__b7198122164934">0</strong>.</p>
</td>
</tr>
<tr id="ListClusterGroup__row943515237173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListClusterGroup__p3437172313178">order_by</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListClusterGroup__p143712236176">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListClusterGroup__p543717230172">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListClusterGroup__p3437823171713">Sorting parameter when the list is queried by page. The value can be <strong id="ListClusterGroup__b9419164724942">create_at</strong> or <strong id="ListClusterGroup__b12849663984942">update_at</strong>.</p>
</td>
</tr>
<tr id="ListClusterGroup__row20435102331716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListClusterGroup__p6437132371714">order</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListClusterGroup__p19438142331717">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListClusterGroup__p0438323111711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListClusterGroup__p1743832312176">Sorting order when the list is queried by page. The value can be <strong id="ListClusterGroup__b17409998234947">desc</strong> or <strong id="ListClusterGroup__b12962990364947">asc</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListClusterGroup__section74381623101716"><h4 class="sectiontitle">Request Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter in the request header</caption><thead align="left"><tr id="ListClusterGroup__row34381223131711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListClusterGroup__p194381723181711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListClusterGroup__p194383237179">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListClusterGroup__p1543912351712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListClusterGroup__p6439182312174">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row16438132321714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListClusterGroup__p18439112351717">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListClusterGroup__p4439523121718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListClusterGroup__p3439152319177">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListClusterGroup__p1266617331861">Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListClusterGroup__section243914234175"><h4 class="sectiontitle">Response Parameters</h4><p id="ListClusterGroup__p1443917230171"><strong id="ListClusterGroup__b198177250443213">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ClusterGroupList" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="ListClusterGroup__row1439323161713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListClusterGroup__p18440423151714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListClusterGroup__p9440823111716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListClusterGroup__p194401123161716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row114391223131714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListClusterGroup__p14440182314173">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListClusterGroup__p154407231172">Array of <a href="#ListClusterGroup__response_ClusterGroup">ClusterGroup</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListClusterGroup__p744032310174">Fleet list</p>
</td>
</tr>
<tr id="ListClusterGroup__row184397231179"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListClusterGroup__p1444013239170">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListClusterGroup__p844012341720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListClusterGroup__p944016238173">Total number of records on all pages</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListClusterGroup__response_ClusterGroup"></a><a name="response_ClusterGroup"></a><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ClusterGroup" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ClusterGroup</caption><thead align="left"><tr id="ListClusterGroup__row14401823131718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListClusterGroup__p8441122351713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListClusterGroup__p1844132311176">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListClusterGroup__p1944112238179">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row144411423141717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListClusterGroup__p1444112311719">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListClusterGroup__p15441923131716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListClusterGroup__p154411423121715">API type. The value is fixed at <strong id="ListClusterGroup__b288711845239">ClusterGroup</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="ListClusterGroup__row5441142381711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListClusterGroup__p10441182331710">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListClusterGroup__p18441123121711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListClusterGroup__p1044192312178">API version. The value is fixed at <strong id="ListClusterGroup__b1841364944162">v1</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="ListClusterGroup__row144172391714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListClusterGroup__p174411223131711">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListClusterGroup__p19441162351714"><a href="#ListClusterGroup__response_ObjectMeta">ObjectMeta</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListClusterGroup__p4442152371719">Basic information about the fleet. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="ListClusterGroup__row24411023191715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListClusterGroup__p14427238176">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListClusterGroup__p4442202381717"><a href="#ListClusterGroup__response_ClusterGroupSpec">ClusterGroupSpec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListClusterGroup__p44420235178">Details about the fleet. UCS creates or updates the fleet based on <strong id="ListClusterGroup__b161111865741719">spec</strong>.</p>
</td>
</tr>
<tr id="ListClusterGroup__row444142391716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListClusterGroup__p13442122301710">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListClusterGroup__p24421323171712"><a href="#ListClusterGroup__response_ClusterGroupStatus">ClusterGroupStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListClusterGroup__p144252312176">Fleet status</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListClusterGroup__response_ObjectMeta"></a><a name="response_ObjectMeta"></a><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ObjectMeta" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ObjectMeta</caption><thead align="left"><tr id="ListClusterGroup__row1144282314179"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListClusterGroup__p944332301716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListClusterGroup__p174439230171">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListClusterGroup__p1544352331713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row9442223101717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListClusterGroup__p114431523161715">uid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListClusterGroup__p1044392317172">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListClusterGroup__p144436237171">Cluster ID</p>
</td>
</tr>
<tr id="ListClusterGroup__row164421223191713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListClusterGroup__p194431023121710">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListClusterGroup__p04436233173">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListClusterGroup__p7443162351712">Cluster name</p>
</td>
</tr>
<tr id="ListClusterGroup__row14442723121716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListClusterGroup__p17443823121715">labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListClusterGroup__p5443823131711">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListClusterGroup__p8443823161716">Labels</p>
</td>
</tr>
<tr id="ListClusterGroup__row11442723101711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListClusterGroup__p7443123141719">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListClusterGroup__p1344312351718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListClusterGroup__p54437239170">Creation time. It is the UTC time in the RFC 3339 format.</p>
</td>
</tr>
<tr id="ListClusterGroup__row7442723171716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListClusterGroup__p7443723151717">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListClusterGroup__p84431923131716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListClusterGroup__p1444422319174">Update timestamp</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListClusterGroup__response_ClusterGroupSpec"></a><a name="response_ClusterGroupSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ClusterGroupSpec" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ClusterGroupSpec</caption><thead align="left"><tr id="ListClusterGroup__row1044410235177"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListClusterGroup__p94443237177">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListClusterGroup__p84441238172">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListClusterGroup__p1844472351710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row16444172381711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p1844413233171">ruleNamespaces</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p444420233177">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p12445423161714">List of namespaces associated with a permission policy</p>
</td>
</tr>
<tr id="ListClusterGroup__row544432315175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p744519239172">federationId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p144452231177">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p1644516239173">ID of the federation enabled for the fleet</p>
</td>
</tr>
<tr id="ListClusterGroup__row644442351718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p04455236177">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p6445323111717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p134459231170">Description</p>
</td>
</tr>
<tr id="ListClusterGroup__row144441723181712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p3445923151715">dnsSuffix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p14445623151718">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p444512391717">DNS suffix of the federation corresponding to the fleet. This parameter is visible after federation is enabled.</p>
</td>
</tr>
<tr id="ListClusterGroup__row184441423151718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p104451623141713">federationExpirationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p1344592301710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p74452023141718">Federation expiration timestamp</p>
</td>
</tr>
<tr id="ListClusterGroup__row13444172318179"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p34451523101718">policyId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p1844511239171">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p9445723121710">Policy management ID</p>
</td>
</tr>
<tr id="ListClusterGroup__row19444182319175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListClusterGroup__p94464232177">federationVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListClusterGroup__p14446162351717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListClusterGroup__p54465237179">Version of the federation enabled for the fleet</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListClusterGroup__response_ClusterGroupStatus"></a><a name="response_ClusterGroupStatus"></a><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ClusterGroupStatus" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ClusterGroupStatus</caption><thead align="left"><tr id="ListClusterGroup__row2446172310171"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListClusterGroup__p13446132313173">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListClusterGroup__p124461923161718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListClusterGroup__p14461723111711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row34461323141715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListClusterGroup__p1344616237177">conditions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListClusterGroup__p12446523111711">Array of <a href="#ListClusterGroup__response_ClusterGroupCondition">ClusterGroupCondition</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListClusterGroup__p104471023111711">Federation or permission policy information for the fleet</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListClusterGroup__response_ClusterGroupCondition"></a><a name="response_ClusterGroupCondition"></a><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__response_ClusterGroupCondition" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ClusterGroupCondition</caption><thead align="left"><tr id="ListClusterGroup__row8447122391717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="ListClusterGroup__p154471523191710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="ListClusterGroup__p13447132361712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="ListClusterGroup__p12447323121718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row644722319173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListClusterGroup__p5447823141719">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListClusterGroup__p744782316176">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListClusterGroup__p174471723101717">Type. Options:</p>
<ul id="ListClusterGroup__ul1448112311179"><li id="ListClusterGroup__li5448132317176"><p id="ListClusterGroup__p1944882361716"><a name="ListClusterGroup__li5448132317176"></a><a name="li5448132317176"></a><strong id="ListClusterGroup__b62493792752724">Federation</strong>: Federation is enabled for the fleet.</p>
</li><li id="ListClusterGroup__li54484230175"><p id="ListClusterGroup__p1744832311174"><a name="ListClusterGroup__li54484230175"></a><a name="li54484230175"></a><strong id="ListClusterGroup__b1692110575493">Policy</strong>: The permission policy is enabled for the fleet.</p>
</li></ul>
</td>
</tr>
<tr id="ListClusterGroup__row1644718235173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListClusterGroup__p1744810236171">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListClusterGroup__p114482236179">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListClusterGroup__p2044842318176">Status of the federation or permission policy enabled for a fleet</p>
</td>
</tr>
<tr id="ListClusterGroup__row1244752313178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListClusterGroup__p344882341711">reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListClusterGroup__p1544820238171">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListClusterGroup__p11448142315179">Cause of a status</p>
</td>
</tr>
<tr id="ListClusterGroup__row7447102319177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListClusterGroup__p1144810239173">message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListClusterGroup__p15448132319178">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListClusterGroup__p1344842315175">Status information</p>
</td>
</tr>
<tr id="ListClusterGroup__row15447192371710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListClusterGroup__p94481523191713">lastTransitionTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListClusterGroup__p1744862318173">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListClusterGroup__p1244882311174">Status update time</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListClusterGroup__section944818231176"><h4 class="sectiontitle">Example Requests</h4><p id="ListClusterGroup__p144484236173">None</p>
</div>
<div class="section" id="ListClusterGroup__section1644916236179"><h4 class="sectiontitle">Example Responses</h4><p id="ListClusterGroup__p104491023181716"><strong id="ListClusterGroup__b148641821743213">Status code: 200</strong></p>
<p id="ListClusterGroup__p18449112331713">The fleet list has been obtained.</p>
<pre class="screen" id="ListClusterGroup__screen74499232174">{
"items" : [ {
"kind" : "ClusterGroup",
"apiVersion" : "v1",
"metadata" : {
"name" : "cluster-test",
"uid" : "bffbb35b-7949-11ee-886c-0255ac100037",
"creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC",
"updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC"
},
"spec" : {
"federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032",
"federationVersion" : "v1.7.0-t1109",
"dnsSuffix" : [ "www.oidc.com" ]
},
"status" : {
"conditions" : [ {
"type" : "Federation",
"status" : "Unavailable",
"reason" : "FederationUnavailable",
"message" : "component volcano-scheduler is unhealthy",
"lastTransitionTime" : "0001-01-01T00:00:00Z"
} ]
}
}, {
"kind" : "ClusterGroup",
"apiVersion" : "v1",
"metadata" : {
"name" : "cluster-dev",
"uid" : "4557ad49-22bf-11ee-b0c9-0255ac10004b",
"creationTimestamp" : "2023-07-15 03:25:39.253589 +0000 UTC",
"updateTimestamp" : "2023-10-19 11:52:14.509405 +0000 UTC"
},
"spec" : { },
"status" : { }
}, {
"kind" : "ClusterGroup",
"apiVersion" : "v1",
"metadata" : {
"name" : "test0131",
"uid" : "108f5981-a105-11ed-a23e-0255ac100032",
"creationTimestamp" : "2023-01-31 01:17:44.309185 +0000 UTC",
"updateTimestamp" : "2023-06-29 01:02:28.78095 +0000 UTC"
},
"spec" : { },
"status" : { }
} ],
"total" : 3
}</pre>
</div>
<div class="section" id="ListClusterGroup__section19568623101711"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListClusterGroup__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListClusterGroup__row7453192317178"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListClusterGroup__p11569102341714">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListClusterGroup__p1569202391719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListClusterGroup__row13453112301719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListClusterGroup__p1456972381715">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListClusterGroup__p1956932331719">The fleet list has been obtained.</p>
</td>
</tr>
<tr id="ListClusterGroup__row6453823121719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListClusterGroup__p1956902319177">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListClusterGroup__p25693232172">Client request error. The server could not execute the request.</p>
</td>
</tr>
<tr id="ListClusterGroup__row1945316233176"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListClusterGroup__p25691323111719">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListClusterGroup__p125699232174">The server refused the request.</p>
</td>
</tr>
<tr id="ListClusterGroup__row154531238179"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListClusterGroup__p9569132313178">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListClusterGroup__p195691123191711">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListClusterGroup__section65691023111713"><h4 class="sectiontitle">Error Codes</h4><p id="ListClusterGroup__p1569142313171">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Fleets</a></div>
</div>
</div>
View Git Blame Copy Permalink