vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/css/api-ref/css_03_0018.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2024-06-07 17:47:08 +00:00

518 lines
38 KiB
HTML
Raw Blame History

<a name="css_03_0018"></a><a name="css_03_0018"></a>
<h1 class="topictitle1">Querying the List of Clusters</h1>
<div id="body1504578045818"><div class="section" id="css_03_0018__section139713321413"><h4 class="sectiontitle">Function</h4><p id="css_03_0018__p0780134120411">This API is used to query and display the cluster list and cluster status.</p>
</div>
<div class="section" id="css_03_0018__section117917455419"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0018__screen1389320295471">GET /v1.0/{project_id}/clusters</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table122471622164219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0018__row3277722174218"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0018__p22775224425">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0018__p132781122134213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0018__p1627842254215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0018__p527842214429">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row727812216429"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0018__p727814223429">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0018__p7278202204212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0018__p13278122294220">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0018__p8278122213423">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0018__row288124713592"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0018__p14974120409">start</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0018__p79741001606">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0018__p20974803013">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0018__p49741306019">Start value of the query. The default value is 1, indicating that the query starts from the first cluster.</p>
</td>
</tr>
<tr id="css_03_0018__row75125712591"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0018__p697419013018">limit</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0018__p119741601605">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0018__p15974503020">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0018__p59741011015">Number of clusters to be queried. The default value is 10, indicating that 10 clusters are queried at a time.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0018__section4136174564211"><h4 class="sectiontitle">Request</h4><p id="css_03_0018__p145600351218">None</p>
</div>
<div class="section" id="css_03_0018__section1756817474311"><h4 class="sectiontitle">Response</h4><p id="css_03_0018__p5268143912410"><a href="#css_03_0018__table29413185430">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="css_03_0018__table29413185430"></a><a name="table29413185430"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table29413185430" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0018__row4149121944318"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0018__p614911197434">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.15%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0018__p12149111974320">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.85000000000001%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0018__p11149171944314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row151491199431"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0018__p191497198431">clusters</p>
</td>
<td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0018__p19149219124316">Array of <a href="#css_03_0018__table9282914163610">clusters</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.85000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0018__p11491819144310">List of cluster objects</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0018__table9282914163610"></a><a name="table9282914163610"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table9282914163610" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="css_03_0018__b18467163084511">clusters</strong> field data structure description</caption><thead align="left"><tr id="css_03_0018__row1528231473610"><th align="left" class="cellrowborder" valign="top" width="25.353535353535356%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0018__p980024833617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.202020202020204%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0018__p78001648113620">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.44444444444444%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0018__p17800114815360">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row1828241419368"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p886374511362">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p12878194514368">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p4878184511366">Type of the data search engine. For details, see <a href="#css_03_0018__table9975151812430">Table 4</a>.</p>
</td>
</tr>
<tr id="css_03_0018__row192821014153614"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p887864510362">instances</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p188781745123613">Array of <a href="#css_03_0018__table13982151814439">instance</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p158784457364">List of node objects</p>
</td>
</tr>
<tr id="css_03_0018__row362914486296"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p4430011123015">updated</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p124301411163014">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p6430151110306">Last modification time of a cluster. The format is <strong id="css_03_0018__b85741858173115">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
</td>
</tr>
<tr id="css_03_0018__row133866503294"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p44311011103020">name</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p144315115309">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p843115112302">Cluster name</p>
</td>
</tr>
<tr id="css_03_0018__row15105175117298"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p943121114309">created</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p343121103012">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p154311118307">Time when a cluster is created. The format is <strong id="css_03_0018__b097012147321">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
<div class="note" id="css_03_0018__note343191143012"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0018__p104315119305">The returned cluster list is sorted by creation time in descending order. Specifically, the cluster with the latest creation time is at the top.</p>
</div></div>
</td>
</tr>
<tr id="css_03_0018__row18814145118292"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p104311911133017">id</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p343141110302">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p1431111117301">Cluster ID.</p>
</td>
</tr>
<tr id="css_03_0018__row1482310569296"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p12431811103016">status</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p1843110116303">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p64311611143010">Return value.</p>
<ul id="css_03_0018__ul1243111113309"><li id="css_03_0018__li543181143018"><strong id="css_03_0018__b1069742117509">100</strong>: Creating.</li><li id="css_03_0018__li1743141183014"><strong id="css_03_0018__b842352706103933">200</strong>: Available.</li><li id="css_03_0018__li174311511163015"><strong id="css_03_0018__b842352706103945">303</strong>: Unavailable, such as creation failed.</li></ul>
</td>
</tr>
<tr id="css_03_0018__row14823175672919"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p14431911133014">endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p543131143012">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p6431151115307">IP address and port number of the user used to access the VPC.</p>
</td>
</tr>
<tr id="css_03_0018__row782317568297"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p1431191183011">actionProgress</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p6431101113020">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p174314112303">Cluster operation progress, which indicates the progress of cluster creation and expansion in percentage. <strong id="css_03_0018__b350518228231">CREATING</strong> specifies the progress of creation.</p>
</td>
</tr>
<tr id="css_03_0018__row282311569298"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p8431101113302">actions</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p2431211113015">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p843117115306">Current behavior on a cluster. Value <strong id="css_03_0018__b679445135411">REBOOTING</strong> indicates that the cluster is being restarted, <strong id="css_03_0018__b4795451135415">GROWING</strong> indicates that capacity expansion is being performed on the cluster, <strong id="css_03_0018__b7797451105419">RESTORING</strong> indicates that the cluster is being restored, and <strong id="css_03_0018__b137976519542">SNAPSHOTTING</strong> indicates that the snapshot is being created.</p>
</td>
</tr>
<tr id="css_03_0018__row7444322301"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p14431151114300">failed_reasons</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p13431011123014">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p3431181115303">Failure cause. If the cluster is in the available status, this parameter is not returned. For details, see <a href="#css_03_0018__table8178483813">Table 6</a>.</p>
</td>
</tr>
<tr id="css_03_0018__row1844572133018"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p1543121114301">httpsEnable</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p1443116111301">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p16431311123011">Communication encryption status.</p>
<p id="css_03_0018__p3431201112306">Value <strong id="css_03_0018__b16437155910303">false</strong> indicates that communication encryption is not enabled.</p>
<p id="css_03_0018__p14311611103014">Value <strong id="css_03_0018__b378111119323">true</strong> indicates that communication encryption is enabled.</p>
</td>
</tr>
<tr id="css_03_0018__row116211638172616"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p18589938102815">authorityEnable</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p17589238152819">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p1158963813282">Indicates whether to enable authentication. Available values include <strong id="css_03_0018__b99099459206">true</strong> and <strong id="css_03_0018__b199091345182014">false</strong>. Authentication is disabled by default. When authentication is enabled, <strong id="css_03_0018__b652144911204">httpsEnable</strong> must be set to <strong id="css_03_0018__b105252049202018">true</strong>.</p>
<ul id="css_03_0018__ul9784127123119"><li id="css_03_0018__li11784927143117">Value <strong id="css_03_0018__b1337216539208">true</strong> indicates that authentication is enabled for the cluster.</li><li id="css_03_0018__li17848278311">Value <strong id="css_03_0018__b5549135720208">false</strong> indicates that authentication is disabled for the cluster.</li></ul>
</td>
</tr>
<tr id="css_03_0018__row134451227306"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p2431141103012">diskEncrypted</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p143181116301">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p9431121143013">Indicates whether disks are encrypted.</p>
<ul id="css_03_0018__ul243111153017"><li id="css_03_0018__li943181143013">Value <strong id="css_03_0018__b317033913413">true</strong> indicates that disks are encrypted.</li><li id="css_03_0018__li16431111113014">Value <strong id="css_03_0018__b142591752184119">false</strong> indicates that disks are not encrypted.</li></ul>
</td>
</tr>
<tr id="css_03_0018__row444515263019"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p1143115115305">cmkId</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p1943151118309">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p943141123012">Key ID used for disk encryption.</p>
</td>
</tr>
<tr id="css_03_0018__row34457293013"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p134311011173011">vpcId</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p14431141123018">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p18431711173013">VPC ID.</p>
</td>
</tr>
<tr id="css_03_0018__row144516273017"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p043111193017">subnetId</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p24312011173012">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p13431181143015">Subnet ID.</p>
</td>
</tr>
<tr id="css_03_0018__row74452023307"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p143112115302">securityGroupId</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p1543111117305">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p1343141112308">Security group ID.</p>
</td>
</tr>
<tr id="css_03_0018__row18833443302"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p180565712308">tags</p>
</td>
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p18051957113013">Array of <a href="#css_03_0018__table112475141284">tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p2805125783010">Tags of a cluster.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0018__table9975151812430"></a><a name="table9975151812430"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table9975151812430" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0018__b1131191682514">datastore</strong> field data structure description</caption><thead align="left"><tr id="css_03_0018__row13150121911438"><th align="left" class="cellrowborder" valign="top" width="25.622562256225624%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0018__p31501719104317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.1025102510251%" id="mcps1.3.4.5.2.4.1.2"><p id="css_03_0018__p0150319114315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.27492749274928%" id="mcps1.3.4.5.2.4.1.3"><p id="css_03_0018__p51501519184319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row4150101911430"><td class="cellrowborder" valign="top" width="25.622562256225624%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0018__p5150131914312">type</p>
</td>
<td class="cellrowborder" valign="top" width="25.1025102510251%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0018__p13150101914312">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.27492749274928%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0018__p121511419174313">Supported type: elasticsearch</p>
</td>
</tr>
<tr id="css_03_0018__row12151101984314"><td class="cellrowborder" valign="top" width="25.622562256225624%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0018__p01511719204313">version</p>
</td>
<td class="cellrowborder" valign="top" width="25.1025102510251%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0018__p16151201913437">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.27492749274928%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0018__p8151191912439">Engine version number. </p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0018__table13982151814439"></a><a name="table13982151814439"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table13982151814439" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="css_03_0018__b276033731118">instances</strong> field data structure description</caption><thead align="left"><tr id="css_03_0018__row1215121974312"><th align="left" class="cellrowborder" valign="top" width="23.962396239623963%" id="mcps1.3.4.6.2.4.1.1"><p id="css_03_0018__p14151181964317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.112311231123112%" id="mcps1.3.4.6.2.4.1.2"><p id="css_03_0018__p17151201911433">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.92529252925292%" id="mcps1.3.4.6.2.4.1.3"><p id="css_03_0018__p1151161944313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row1815117192431"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p11151101920433">type</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p2015271994316">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p10152191964318">Supported type: ess (indicating the Elasticsearch node)</p>
</td>
</tr>
<tr id="css_03_0018__row01521919194312"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p51521019134316">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p2015211914310">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p61523191437">Instance ID.</p>
</td>
</tr>
<tr id="css_03_0018__row1515291994319"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p715212193434">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p715241915437">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p1615251915435">Instance name.</p>
</td>
</tr>
<tr id="css_03_0018__row2015291934315"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p8152101944315">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p201521219114311">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p121521196435">Instance status.</p>
<ul id="css_03_0018__ul16840111884318"><li id="css_03_0018__li1884015188432"><strong id="css_03_0018__b19472182915515">100</strong>: Creating.</li><li id="css_03_0018__li7840131864313"><strong id="css_03_0018__b1973867145">200</strong>: Available.</li><li id="css_03_0018__li4121425154318"><strong id="css_03_0018__b2089824571">303</strong>: Unavailable, such as creation failed.</li></ul>
</td>
</tr>
<tr id="css_03_0018__row5905112522318"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p49051325132314">specCode</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p14905152552318">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p17905112532312">Node specifications.</p>
</td>
</tr>
<tr id="css_03_0018__row899931202319"><td class="cellrowborder" valign="top" width="23.962396239623963%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0018__p169915315238">azCode</p>
</td>
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0018__p499731102310">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.92529252925292%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0018__p3991314239">AZ to which a node belongs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0018__table8178483813"></a><a name="table8178483813"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table8178483813" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="css_03_0018__b11260177114117">failed_reasons</strong> field data structure description</caption><thead align="left"><tr id="css_03_0018__row8253482812"><th align="left" class="cellrowborder" valign="top" width="18.98189818981898%" id="mcps1.3.4.7.2.4.1.1"><p id="css_03_0018__p18281848480">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.15261526152615%" id="mcps1.3.4.7.2.4.1.2"><p id="css_03_0018__p2312481489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.865486548654864%" id="mcps1.3.4.7.2.4.1.3"><p id="css_03_0018__p2334487817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row1338648286"><td class="cellrowborder" valign="top" width="18.98189818981898%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0018__p14284815811">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="26.15261526152615%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0018__p1144134815812">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.865486548654864%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0018__p13335142981118">Error code.</p>
<ul id="css_03_0018__ul83351829161110"><li id="css_03_0018__li5335202916118">CSS.6000: indicates that a cluster fails to be created.</li><li id="css_03_0018__li1233502971116">CSS.6001: indicates that a cluster fails to be scaled out.</li><li id="css_03_0018__li203352296117">CSS.6002: indicates that a cluster fails to be restarted.</li><li id="css_03_0018__li1633552911115">CSS.6004: indicates that a node fails to be created in a cluster.</li><li id="css_03_0018__li1643171861313">CSS.6005: indicates that the service fails to be initialized.</li></ul>
</td>
</tr>
<tr id="css_03_0018__row1048548282"><td class="cellrowborder" valign="top" width="18.98189818981898%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0018__p185013481281">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="26.15261526152615%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0018__p155214489814">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.865486548654864%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0018__p65415487814">Detailed error information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0018__table112475141284"></a><a name="table112475141284"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table112475141284" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="css_03_0018__b745574175711">tags</strong> field data structure description</caption><thead align="left"><tr id="css_03_0018__row82641214122820"><th align="left" class="cellrowborder" valign="top" width="18.84188418841884%" id="mcps1.3.4.8.2.4.1.1"><p id="css_03_0018__p02685146289">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.62206220622062%" id="mcps1.3.4.8.2.4.1.2"><p id="css_03_0018__p1127141452811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.53605360536053%" id="mcps1.3.4.8.2.4.1.3"><p id="css_03_0018__p1727341482814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row12761014192815"><td class="cellrowborder" valign="top" width="18.84188418841884%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0018__p1228031452815">key</p>
</td>
<td class="cellrowborder" valign="top" width="20.62206220622062%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0018__p128571418285">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.53605360536053%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0018__p928881412813">Tag key.</p>
</td>
</tr>
<tr id="css_03_0018__row183051414102810"><td class="cellrowborder" valign="top" width="18.84188418841884%" headers="mcps1.3.4.8.2.4.1.1 "><p id="css_03_0018__p1630841413288">value</p>
</td>
<td class="cellrowborder" valign="top" width="20.62206220622062%" headers="mcps1.3.4.8.2.4.1.2 "><p id="css_03_0018__p1531161410287">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.53605360536053%" headers="mcps1.3.4.8.2.4.1.3 "><p id="css_03_0018__p1431521462820">Tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0018__section17653145262114"><h4 class="sectiontitle">Examples</h4><ul id="css_03_0018__ul29001733131716"><li id="css_03_0018__li1737493118221">Example request<ul id="css_03_0018__ul1034323714226"><li id="css_03_0018__li590063319173">Example request of querying clusters. A maximum of 10 clusters can be queried by default.<pre class="screen" id="css_03_0018__screen65005584218">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters</pre>
</li></ul>
<ul id="css_03_0018__ul462781011417"><li id="css_03_0018__li662751013147">Example request of querying clusters by page<p id="css_03_0018__p111427531306"><a name="css_03_0018__li662751013147"></a><a name="li662751013147"></a>Example 1: Query the first two clusters.</p>
<p id="css_03_0018__p143801911119">Method 1</p>
<pre class="screen" id="css_03_0018__screen3108212164514">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&amp;limit=2</pre>
<div class="p" id="css_03_0018__p5888854122118">Method 2<pre class="screen" id="css_03_0018__screen2460115554016">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2</pre>
</div>
<p id="css_03_0018__p66983561058">Example 2: Query the first 10 clusters.</p>
<div class="p" id="css_03_0018__p11903754172118">Method 1<pre class="screen" id="css_03_0018__screen1131817489593">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&amp;limit=10</pre>
</div>
<div class="p" id="css_03_0018__p790312541219">Method 2<pre class="screen" id="css_03_0018__screen1433434813594">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1</pre>
</div>
</li></ul>
</li><li id="css_03_0018__li99046529223">Example response<pre class="screen" id="css_03_0018__screen160218426363">{
"clusters": [
{
"datastore": {
"type": "elasticsearch",
"version": "7.6.2"
},
"instances": [
{
"status": "200",
"type": "ess",
"id": "c8c90973-924d-4201-b9ff-f32279c87d0e",
"name": "css-5492-ess-esn-1-1",
"specCode": "css.xlarge.2",
"azCode": "eu-de-01"
}
],
"updated": "2020-12-01T07:47:34",
"name": "css-5492",
"created": "2020-12-01T07:47:34",
"id": "66ea1e42-4ee2-44ad-bd80-c86e6d8c6b9e",
"status": "200",
"endpoint": "10.16.0.151:9200",
"vpcId": "e7daa617-3ee6-4ff1-b042-8cda4a006a46",
"subnetId": "6253dc44-24cd-4c0a-90b3-f965e7f4dcd4",
"securityGroupId": "d478041e-bcbe-4d69-a492-b6122d774b7f",
"httpsEnable": false,
"authorityEnable": false,
"diskEncrypted": true,
"cmkId": "00f05033-f8ac-4ceb-a1ce-4072fadb6b28",
"actionProgress": {},
"actions": [],
"tags": []
},
{
"datastore": {
"type": "elasticsearch",
"version": "7.6.2"
},
"instances": [
{
"status": "200",
"type": "ess",
"id": "a24adddb-1553-4873-9978-9d064418f903",
"name": "css-1d01-ess-esn-1-1",
"specCode": "css.xlarge.2",
"azCode": "eu-de-01"
}
],
"updated": "2020-11-26T10:08:44",
"name": "css-1d01",
"created": "2020-11-26T10:08:44",
"id": "af5fbac7-b386-4305-b201-820a0f51f4f1",
"status": "200",
"endpoint": "10.16.0.124:9200",
"vpcId": "e7daa617-3ee6-4ff1-b042-8cda4a006a46",
"subnetId": "6253dc44-24cd-4c0a-90b3-f965e7f4dcd4",
"securityGroupId": "d478041e-bcbe-4d69-a492-b6122d774b7f",
"httpsEnable": true,
"authorityEnable": false,
"diskEncrypted": false,
"cmkId": "",
"actionProgress": {},
"actions": [],
"tags": []
},
{
"datastore": {
"type": "elasticsearch",
"version": "7.6.2"
},
"instances": [
{
"status": "303",
"type": "ess",
"id": "071c7ecf-a11d-45bd-9564-201ceb7cfae3",
"name": "css-9b36-ess-esn-1-1",
"specCode": "css.xlarge.2",
"azCode": "eu-de-01"
}
],
"updated": "2020-11-13T14:33:24",
"name": "css-9b36",
"created": "2020-11-13T14:33:26",
"id": "cdb26954-c743-47dd-b23a-b693205eb2da",
"status": "303",
"endpoint": null,
"vpcId": "e7daa617-3ee6-4ff1-b042-8cda4a006a46",
"subnetId": "6253dc44-24cd-4c0a-90b3-f965e7f4dcd4",
"securityGroupId": "d478041e-bcbe-4d69-a492-b6122d774b7f",
"httpsEnable": true,
"authorityEnable": true,
"diskEncrypted": false,
"cmkId": "",
"actionProgress": {},
"actions": [],
"tags": []
}
]
}</pre>
<p id="css_03_0018__p18552183319329"></p>
</li></ul>
</div>
<div class="section" id="css_03_0018__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0018__p99014501142"><a href="#css_03_0018__table6970123517140">Table 8</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0018__table6970123517140"></a><a name="table6970123517140"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0018__table6970123517140" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status codes</caption><thead align="left"><tr id="css_03_0018__row1972183521418"><th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0018__p14560134151414">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.04%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0018__p5563194141411">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0018__p256616411143">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0018__row129720356144"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0018__p1957004131410">400</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0018__p165731141171419">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0018__p65778413148">Invalid request.</p>
<p id="css_03_0018__p1557974171415">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0018__row8972103517147"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0018__p75841441191410">404</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0018__p258716416142">NotFound</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0018__p15589154118141">The requested resource cannot be found.</p>
<p id="css_03_0018__p14590164151410">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0018__row297223511416"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0018__p13595164131416">200</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0018__p9598741131416">OK</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0018__p659994115146">The request is processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink