vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/css/api-ref/css_03_0026.html
Zheng, Xiu c8d7a6f7c1 CSS API 20230223 Version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2023-02-28 10:52:22 +00:00

406 lines
31 KiB
HTML
Raw Blame History

<a name="css_03_0026"></a><a name="css_03_0026"></a>
<h1 class="topictitle1">Querying Cluster Details</h1>
<div id="body1517295755272"><div class="section" id="css_03_0026__section31951730334"><h4 class="sectiontitle">Function</h4><p id="css_03_0026__p2399173012311">This API is used to query and display details about a cluster.</p>
</div>
<div class="section" id="css_03_0026__section111957301639"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0026__screen15206531255">GET /v1.0/{project_id}/clusters/{cluster_id}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table721120301031" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0026__row439920301735"><th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0026__p18399103015317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.740000000000002%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0026__p7399143017310">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.56%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0026__p1139910301639">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0026__p6399143019310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row1339913301636"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0026__p1539993015315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0026__p1239911301737">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0026__p193991630734">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0026__p039918302317">Project ID. </p>
</td>
</tr>
<tr id="css_03_0026__row143991230731"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0026__p1139918307319">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0026__p33998308318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0026__p153994301318">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0026__p539911301733">ID of the cluster to be queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0026__section142271830233"><h4 class="sectiontitle">Request</h4><p id="css_03_0026__p132419255264">None</p>
</div>
<div class="section" id="css_03_0026__section72271330831"><h4 class="sectiontitle">Response</h4><p id="css_03_0026__p12491135612268"><a href="#css_03_0026__table372832271213">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="css_03_0026__table372832271213"></a><a name="table372832271213"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table372832271213" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0026__row172822201216"><th align="left" class="cellrowborder" valign="top" width="16.333333333333336%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0026__p102799549123">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.070707070707073%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0026__p1927965418126">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.59595959595959%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0026__p8279254121216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row1728172231215"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p1027935418122">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p1527915415128">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p027905411219">Type of the data search engine. For details, see <a href="#css_03_0026__table1060833515712">Table 3</a>.</p>
</td>
</tr>
<tr id="css_03_0026__row1172862211210"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p18279754161220">instances</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p16279105461215">Array of instances in <a href="#css_03_0026__table6945141813">Table 4</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p02791054121213">List of node objects.</p>
</td>
</tr>
<tr id="css_03_0026__row187284223121"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p10279115419121">updated</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p4279145481214">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p227915411211">Last modification time of a cluster. The format is <strong id="css_03_0026__b44132588322">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
</td>
</tr>
<tr id="css_03_0026__row18728132241214"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p1427916545123">name</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p8279145431210">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p8279454101215">Cluster name.</p>
</td>
</tr>
<tr id="css_03_0026__row2728192231218"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p22791654121214">created</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p12279154121213">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p13279154111211">Time when a cluster is created. The format is <strong id="css_03_0026__b11101013311">ISO8601: CCYY-MM-DDThh:mm:ss</strong>.</p>
</td>
</tr>
<tr id="css_03_0026__row772812225127"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p727955491216">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p82792054181216">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p527985417129">Cluster ID.</p>
</td>
</tr>
<tr id="css_03_0026__row16728152271215"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p1927985410124">status</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p1927955401216">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p02795545129">Return value.</p>
<ul id="css_03_0026__ul72793548129"><li id="css_03_0026__li12791854121213"><strong id="css_03_0026__b842352706152659">100</strong>: The operation, such as instance creation, is in progress.</li><li id="css_03_0026__li327995416126"><strong id="css_03_0026__b842352706103933">200</strong>: The cluster is available.</li><li id="css_03_0026__li19279354121217"><strong id="css_03_0026__b842352706103945">303</strong>: The cluster is unavailable.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row151501130181220"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p202791654161213">endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p427919549123">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p16279155415123">Indicates the IP address and port number of the user used to access the VPC.</p>
</td>
</tr>
<tr id="css_03_0026__row274411333129"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p32791054151216">actionProgress</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p727914545121">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p72796543128">Cluster operation progress, which indicates the progress of cluster creation and expansion in percentage.</p>
</td>
</tr>
<tr id="css_03_0026__row852519374124"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p18279185413120">actions</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p827905481211">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p7481181175918">Current behavior on a cluster. Value <strong id="css_03_0026__b4252206554">REBOOTING</strong> indicates that the cluster is being restarted, <strong id="css_03_0026__b1826320115510">GROWING</strong> indicates that capacity expansion is being performed on the cluster, <strong id="css_03_0026__b162612203557">RESTORING</strong> indicates that the cluster is being restored, and <strong id="css_03_0026__b17271520185511">SNAPSHOTTING</strong> indicates that the snapshot is being created.</p>
</td>
</tr>
<tr id="css_03_0026__row165951256111516"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p145956566157">failed_reasons</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p11595656151513">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p35952056121518">Failure cause. If the cluster is in the Available state, this parameter is not returned. For details, see <a href="#css_03_0026__table57969612189">Table 5</a>.</p>
</td>
</tr>
<tr id="css_03_0026__row65960327244"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p159683215247">httpsEnable</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p259612323242">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p1059663272410">Communication encryption status.</p>
<ul id="css_03_0026__ul10157125063914"><li id="css_03_0026__li1715885020396">Value <strong id="css_03_0026__b5552192553419">false</strong> indicates that communication encryption is not enabled.</li><li id="css_03_0026__li11971052123914">Value <strong id="css_03_0026__b1860542718347">true</strong> indicates that communication encryption has been enabled.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row16582204793110"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p18589938102815">authorityEnable</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p17589238152819">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p1158963813282">Whether to enable authentication. Available values include <strong id="css_03_0026__b1433713214269">true</strong> and <strong id="css_03_0026__b6338113218263">false</strong>. Authentication is disabled by default. When authentication is enabled, <strong id="css_03_0026__b1321017437260">httpsEnable</strong> must be set to <strong id="css_03_0026__b52158437263">true</strong>.</p>
<ul id="css_03_0026__ul9784127123119"><li id="css_03_0026__li11784927143117">Value <strong id="css_03_0026__b18874154717266">true</strong> indicates that authentication is enabled for the cluster.</li><li id="css_03_0026__li17848278311">Value <strong id="css_03_0026__b330015019268">false</strong> indicates that authentication is disabled for the cluster.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row13734141262113"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p18734512202119">diskEncrypted</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p18734141211217">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p5734111215212">Whether disks are encrypted.</p>
<ul id="css_03_0026__ul197793115619"><li id="css_03_0026__li1077143115612">Value <strong id="css_03_0026__b4529123813425">true</strong> indicates that disks are encrypted.</li><li id="css_03_0026__li17771531165618">Value <strong id="css_03_0026__b1221263913429">false</strong> indicates that disks are not encrypted.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row17352242317"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p127353218233">cmkId</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p4735112122314">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p1673517202311">Key ID used for disk encryption.</p>
</td>
</tr>
<tr id="css_03_0026__row19613203673517"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p7613113615359">vpcId</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p19613436173520">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p86131936203512">VPC ID.</p>
</td>
</tr>
<tr id="css_03_0026__row3602724360"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p560272173611">subnetId</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p156028233619">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p14602192143615">Subnet ID.</p>
</td>
</tr>
<tr id="css_03_0026__row73171419163619"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p1431791914365">securityGroupId</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p23171194363">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p123171219203612">Security group ID.</p>
</td>
</tr>
<tr id="css_03_0026__row14247915153011"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p924714153306">tags</p>
</td>
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p182471615163011">Array of tags in <a href="#css_03_0026__table8715643173020">Table 6</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p152471515133012">Tags in a cluster.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0026__table1060833515712"></a><a name="table1060833515712"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table1060833515712" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong>datastore</strong> field data structure description</caption><thead align="left"><tr id="css_03_0026__row560820358713"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0026__p84144301433">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.5%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0026__p18414930739">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.50000000000001%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0026__p341423015314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row46081935873"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0026__p841420301030">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.5%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0026__p1141416308313">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.50000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0026__p154144301833">Supported type: elasticsearch</p>
</td>
</tr>
<tr id="css_03_0026__row2608103518711"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0026__p1941493017319">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.5%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0026__p241412301836">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.50000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0026__p941413305319">Engine version number.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0026__table6945141813"></a><a name="table6945141813"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table6945141813" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0026__b9746536194">instances</strong> field data structure description</caption><thead align="left"><tr id="css_03_0026__row169419141184"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.5.2.4.1.1"><p id="css_03_0026__p34142301319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.98%" id="mcps1.3.4.5.2.4.1.2"><p id="css_03_0026__p541410301436">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.019999999999996%" id="mcps1.3.4.5.2.4.1.3"><p id="css_03_0026__p2414330339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row19944141083"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p4414203015312">type</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p841415303315">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p144141030137">Supported type: ess (indicating the Elasticsearch node)</p>
</td>
</tr>
<tr id="css_03_0026__row6949141182"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p941410301316">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p841413308313">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p1141410300312">Instance ID.</p>
</td>
</tr>
<tr id="css_03_0026__row13941214985"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p241412302032">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p2414230038">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p194142301934">Instance name.</p>
</td>
</tr>
<tr id="css_03_0026__row109417148815"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p1541416301036">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p34141330836">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p1241414301531">Instance status.</p>
<ul id="css_03_0026__ul1641411301333"><li id="css_03_0026__li8414730235"><strong id="css_03_0026__b80565402">100</strong>: The operation, such as instance creation, is in progress.</li><li id="css_03_0026__li134147306319"><strong id="css_03_0026__b1486539161">200</strong>: The instance is available.</li><li id="css_03_0026__li1341415300318"><strong id="css_03_0026__b1155468667">303</strong>: The instance is unavailable.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row1975633613120"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p1575615364314">specCode</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p8756123612316">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p775603619319">Node specifications.</p>
</td>
</tr>
<tr id="css_03_0026__row6893336181910"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.5.2.4.1.1 "><p id="css_03_0026__p889393621913">azCode</p>
</td>
<td class="cellrowborder" valign="top" width="23.98%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0026__p889333618192">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.019999999999996%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0026__p9893136151913">AZ to which a node belongs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0026__table57969612189"></a><a name="table57969612189"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table57969612189" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="css_03_0026__b153891022193816">failed_reasons</strong> field data structure description</caption><thead align="left"><tr id="css_03_0026__row13802166151810"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.6.2.4.1.1"><p id="css_03_0026__p128041560187">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.6.2.4.1.2"><p id="css_03_0026__p20806116101810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.4.6.2.4.1.3"><p id="css_03_0026__p880720616185">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row108081469182"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0026__p680916661820">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0026__p1781046131813">String</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0026__p13335142981118">Error code.</p>
<ul id="css_03_0026__ul83351829161110"><li id="css_03_0026__li5335202916118">CSS.6000: indicates that a cluster fails to be created.</li><li id="css_03_0026__li1233502971116">CSS.6001: indicates that capacity expansion of a cluster fails.</li><li id="css_03_0026__li203352296117">CSS.6002: indicates that a cluster fails to be restarted.</li><li id="css_03_0026__li1633552911115">CSS.6004: indicates that a node fails to be created in a cluster.</li><li id="css_03_0026__li1643171861313">CSS.6005: indicates that the service fails to be initialized.</li></ul>
</td>
</tr>
<tr id="css_03_0026__row88153612185"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.6.2.4.1.1 "><p id="css_03_0026__p681614661811">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.6.2.4.1.2 "><p id="css_03_0026__p681756191816">String</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.6.2.4.1.3 "><p id="css_03_0026__p65415487814">Detailed error information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0026__table8715643173020"></a><a name="table8715643173020"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table8715643173020" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="css_03_0026__b25837274580">tags</strong> field data structure description</caption><thead align="left"><tr id="css_03_0026__row5722174303012"><th align="left" class="cellrowborder" valign="top" width="24.01%" id="mcps1.3.4.7.2.4.1.1"><p id="css_03_0026__p12724194312307">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.47%" id="mcps1.3.4.7.2.4.1.2"><p id="css_03_0026__p872774316304">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.4.7.2.4.1.3"><p id="css_03_0026__p14729144313308">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__row273124320306"><td class="cellrowborder" valign="top" width="24.01%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0026__p673444313302">key</p>
</td>
<td class="cellrowborder" valign="top" width="24.47%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0026__p37361543103011">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0026__p1573894311302">Tag key.</p>
</td>
</tr>
<tr id="css_03_0026__row1751243103020"><td class="cellrowborder" valign="top" width="24.01%" headers="mcps1.3.4.7.2.4.1.1 "><p id="css_03_0026__p167531543143013">value</p>
</td>
<td class="cellrowborder" valign="top" width="24.47%" headers="mcps1.3.4.7.2.4.1.2 "><p id="css_03_0026__p1575514393011">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.7.2.4.1.3 "><p id="css_03_0026__p47572043103012">Tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0026__section19991837172616"><h4 class="sectiontitle">Examples</h4><p id="css_03_0026__p1739943011319">Example request</p>
<pre class="screen" id="css_03_0026__screen1039953010312">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/5c77b71c-5b35-4f50-8984-76387e42451a</pre>
<p id="css_03_0026__p541415301733">Example response</p>
<pre class="screen" id="css_03_0026__screen17248121218436">{
"datastore": {
"type": "elasticsearch",
"version": "7.6.2"
},
"instances": [
{
"status": "200",
"type": "ess",
"id": "c2f29369-1985-4028-8e72-89cbb96a299d",
"name": "css-5977-ess-esn-1-1",
"specCode": "css.xlarge.2",
"azCode": "eu-de-01"
}
],
"updated": "2020-12-03T07:02:08",
"name": "css-5977",
"created": "2020-12-03T07:02:08",
"id": "bc8ea974-77ef-46de-b011-918b0fdedb45",
"status": "200",
"endpoint": "10.16.0.88:9200",
"vpcId": "e7daa617-3ee6-4ff1-b042-8cda4a006a46",
"subnetId": "6253dc44-24cd-4c0a-90b3-f965e7f4dcd4",
"securityGroupId": "d478041e-bcbe-4d69-a492-b6122d774b7f",
"httpsEnable": true,
"authorityEnable": true,
"diskEncrypted": false,
"actionProgress": {},
"actions": [],
"tags": []
}</pre>
</div>
<div class="section" id="css_03_0026__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0026__p41501318171512"><a href="#css_03_0026__table10194172917151">Table 7</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0026__table10194172917151"></a><a name="table10194172917151"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0026__table10194172917151" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status code</caption><thead align="left"><tr id="css_03_0026__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_0026__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_0026__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_0026__css_03_0018_p256616411143">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0026__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_0026__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_0026__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_0026__css_03_0018_p65778413148">Invalid request.</p>
<p id="css_03_0026__css_03_0018_p1557974171415">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0026__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_0026__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_0026__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_0026__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
<p id="css_03_0026__css_03_0018_p14590164151410">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0026__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_0026__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_0026__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_0026__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