vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_newapi_0030.html
Ru, Li Yi d97aea4dd2 opengauss_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-09-06 09:04:21 +00:00

354 lines
30 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001917130628"></a><a name="EN-US_TOPIC_0000001917130628"></a>
<h1 class="topictitle1">Querying the Components of a DB Instance</h1>
<div id="body0000001244118814"><div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p1779463834710">This API is used to query components of a DB instance. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>GET https://{<em id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/components?limit={limit}&amp;offset={offset}</p>
</li><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/components?limit=5&amp;offset=10</p>
</li><li id="EN-US_TOPIC_0000001917130628__li668110106474">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_table1986313483146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_row158631348151416"><th align="left" class="cellrowborder" valign="top" width="21.08%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p178635485145">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.2.2.3.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917130628__p174351219402">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.31%" id="mcps1.3.2.2.3.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p586384819144">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.09%" id="mcps1.3.2.2.3.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_p3863164871419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130628__row153821619455"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427214_p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p197439120408">string</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427214_p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p19528455451">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917130628__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row221263219236"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__p021393214239">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p174311214409">string</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__p0213832162312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p122132326234">DB instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row371621324112"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__p167160134412">limit</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p1071618139416">integer</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__p6716131316417">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p19716151334116">Number of records to be queried. The default value is <strong id="EN-US_TOPIC_0000001917130628__b22250841825356">100</strong>. The value cannot be a negative number. The minimum value is <strong id="EN-US_TOPIC_0000001917130628__b79175461125356">1</strong> and the maximum value is <strong id="EN-US_TOPIC_0000001917130628__b198745948225356">100</strong>. For example, if this parameter is set to <strong id="EN-US_TOPIC_0000001917130628__b51947202125356">10</strong>, a maximum of 10 records can be displayed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row314702513395"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__p8147122523913">offset</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p197431412164016">integer</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__p18147112513910">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p6306125181411">Index offset. If <strong id="EN-US_TOPIC_0000001917130628__b2014202752102226">offset</strong> is set to <em id="EN-US_TOPIC_0000001917130628__i1599798280102226">N</em>, the resource query starts from the N+1 piece of data. The default value is <strong id="EN-US_TOPIC_0000001917130628__b1564768980102226">0</strong>, indicating that the query starts from the first piece of data. The value cannot be a negative number. For example, if this parameter is set to <strong id="EN-US_TOPIC_0000001917130628__b131521353123819">0</strong> and <strong id="EN-US_TOPIC_0000001917130628__b215335315384">limit</strong> is set to <strong id="EN-US_TOPIC_0000001917130628__b1315325319386">10</strong>, only the 1st to 10th records are displayed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row9396309318"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__p641430933">component_type</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p1413301232">string</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__p64163011316">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p9595879911">Component type. If this parameter is <strong id="EN-US_TOPIC_0000001917130628__b17613132913281">ALL</strong> (default value), all types of components are queried. <strong id="EN-US_TOPIC_0000001917130628__b11731648112917">CM</strong>: CMS components Value:</p>
<ul id="EN-US_TOPIC_0000001917130628__ul14595107595"><li id="EN-US_TOPIC_0000001917130628__li195951571999">ALL</li><li id="EN-US_TOPIC_0000001917130628__li185961379919">CN</li><li id="EN-US_TOPIC_0000001917130628__li115962075911">DN</li><li id="EN-US_TOPIC_0000001917130628__li13596177793">CM</li><li id="EN-US_TOPIC_0000001917130628__li4596577918">GTM</li><li id="EN-US_TOPIC_0000001917130628__li1770816125910">ETCD</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row1631464816912"><td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130628__p183154481595">availability_zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130628__p1331611481095">string</p>
</td>
<td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130628__p331644812910">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.09%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130628__p2031684815914">ID of the AZ where the primary component is located. The default value is <strong id="EN-US_TOPIC_0000001917130628__b4766104153018">ALL</strong>, indicating that component information of nodes in all AZs of the instance is queried. When you query the AZ where a primary DN is located, the information of all DNs in the same shard as the primary DN is displayed. When you query the AZ where a CN is located, only the CN information in the AZ is displayed. When you query the AZ where a component (except CNs or DNs) is located, information about all components of the same type is returned. If there is no such a component, no information is returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917130628__p153880764610">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_section415313301118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_ul48268995"><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_li31767774">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p32787233">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.91%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p38520254">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.71%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p33132859">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_row66515904"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p19079158">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p148451042014">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.71%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p48735027">Component details.</p>
<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p31211412488">For details, see <a href="#EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_table175305610274">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row1565571791720"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p9656917141719">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p8656121791718">integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.71%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p14656217191720">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_table175305610274"></a><a name="en-us_topic_0128427213_table175305610274"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_table175305610274" frame="border" border="1" rules="all"><caption><b>Table 3 </b>nodes description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_row4782256142718"><th align="left" class="cellrowborder" valign="top" width="26.200000000000003%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p11791105616272">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.7%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p1280910568278">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_p081620561276">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_row83685201297"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p74330101152">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p143321013517">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p1243311019514">Node ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_row1587195662712"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p7433131014519">components</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p44335102053">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p7433410657">Component information under the instance node. For details, see <a href="#EN-US_TOPIC_0000001917130628__table1863685614294">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row362674120120"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p1063133991315">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p166393971317">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p5631390133">Node name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row82581241131"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p610261181415">availability_zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p121027171411">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p16102131171415">Code of the AZ where the node is located.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row13678105414129"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p13103201141410">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p1310312191418">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p20103201151410">AZ description.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row19197849111214"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p21039116147">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.7%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p310321131418">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p0103151111412">Node status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130628__table1863685614294"></a><a name="table1863685614294"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130628__table1863685614294" frame="border" border="1" rules="all"><caption><b>Table 4 </b>components description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130628__row46361456202915"><th align="left" class="cellrowborder" valign="top" width="26.200000000000003%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001917130628__p1363618568294">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.689999999999998%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001917130628__p1663625682911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.11%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001917130628__p063665642915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130628__row36361156202918"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p176361556192914">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p106366562297">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p963610563291">Component ID.</p>
<p id="EN-US_TOPIC_0000001917130628__p1713801991514">Global Transaction Manager (GTM): manages the status of transactions.</p>
<p id="EN-US_TOPIC_0000001917130628__p71386194157">Cluster Management Server (CMS): manages the instance status.</p>
<p id="EN-US_TOPIC_0000001917130628__p3138141916158">Data node (DN): stores and queries table data.</p>
<p id="EN-US_TOPIC_0000001917130628__p133134192913">Coordinator node (CN): stores database metadata, distributes and executes query tasks, and then returns the query results from DNs to applications.</p>
<p id="EN-US_TOPIC_0000001917130628__p15138111921519">Editable Text Configuration Daemon (ETCD): serves as a distributed key-value storage system used for configuration sharing and service discovery (registration and search).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row963612567299"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p126371456172919">role</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p156371756182912">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p1663785614299">Node role.</p>
<p id="EN-US_TOPIC_0000001917130628__p14869120152713"><strong id="EN-US_TOPIC_0000001917130628__b614219279298">master</strong>: primary node</p>
<p id="EN-US_TOPIC_0000001917130628__p11514105722612"><strong id="EN-US_TOPIC_0000001917130628__b957185516296">slave</strong>: standby node</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row13613424307"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p1736219423301">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p73621742193011">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p1336254273016">Component status.</p>
<p id="EN-US_TOPIC_0000001917130628__p137517521233"><strong id="EN-US_TOPIC_0000001917130628__b16968176133020">Primary</strong>: primary component</p>
<p id="EN-US_TOPIC_0000001917130628__p991319355417"><strong id="EN-US_TOPIC_0000001917130628__b1687113413307">Normal</strong>: The component is normal.</p>
<p id="EN-US_TOPIC_0000001917130628__p52855431744"><strong id="EN-US_TOPIC_0000001917130628__b382275743010">Down</strong>: The component is abnormal.</p>
<p id="EN-US_TOPIC_0000001917130628__p964418461741"><strong id="EN-US_TOPIC_0000001917130628__b13638227203119">Standby</strong>: standby component</p>
<p id="EN-US_TOPIC_0000001917130628__p878416511248"><strong id="EN-US_TOPIC_0000001917130628__b188072410311">StateFollower</strong>: standby ETCD</p>
<p id="EN-US_TOPIC_0000001917130628__p1492814597411"><strong id="EN-US_TOPIC_0000001917130628__b34653490318">StateLeader</strong>: primary ETCD</p>
<p id="EN-US_TOPIC_0000001917130628__p1546718820"><strong id="EN-US_TOPIC_0000001917130628__b192761036164412">StateCandidate</strong>: arbitration ETCD</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row12394182931412"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p165198017152">distributed_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p10519200151520">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p1151917010152">Group ID. This parameter is used to identify DNs in the same shard. For other components, the value is an empty string.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row10959192261712"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p18669134111170">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p19669124113176">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p7669441201713">Node type. Value: <strong id="EN-US_TOPIC_0000001917130628__b101145138442">DN</strong>, <strong id="EN-US_TOPIC_0000001917130628__b12400181594418">CN</strong>, <strong id="EN-US_TOPIC_0000001917130628__b4435161811445">GTM</strong>, <strong id="EN-US_TOPIC_0000001917130628__b1373172117442">CM</strong>, or <strong id="EN-US_TOPIC_0000001917130628__b237016287446">ETCD</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130628__row87811728181713"><td class="cellrowborder" valign="top" width="26.200000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130628__p187531750161719">detail</p>
</td>
<td class="cellrowborder" valign="top" width="22.689999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130628__p775316505173">string</p>
</td>
<td class="cellrowborder" valign="top" width="51.11%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130628__p14753155013173">Details.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001917130628__ul31923327101549"><li id="EN-US_TOPIC_0000001917130628__li27619632">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917130628__codeblock422048114712">{
"nodes": [
{
"components": [
{
"id": "cm_1",
"role": "master",
"status": "Primary",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7001",
"role": "master",
"status": "StateLeader",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6001",
"role": "master",
"status": "Primary",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "7d19f72f8f514564bd92962a6fbddb7dno14",
"name": "gauss-9e1a_root_0",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "cm_3",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7003",
"role": "slave",
"status": "StateFollower",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6003",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "aafc2e14234d4c9eadb481fb0a09a865no14",
"name": "gauss-9e1a_root_2",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "cm_2",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7002",
"role": "slave",
"status": "StateFollower",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6002",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "d6c6c6e6b48c41d79d99d7240751d744no14",
"name": "gauss-9e1a_root_1",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
}
],
"total_count": 3
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
</li><li id="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917130628__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130628__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917130628__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0014.html">Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink