vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/api-ref/dws_02_0018.html
Lu, Huayi 24f47208ec DWS API 831.100 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-10-07 10:18:56 +00:00

537 lines
50 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001185833140"></a><a name="EN-US_TOPIC_0000001185833140"></a>
<h1 class="topictitle1">Querying the Cluster List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_s7824f9daa8b546c086192e45721e6e61"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p8928942">This API is used to query and display the cluster list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_s18625cd3bdc8450a85dc8bff5ee9c3ab"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_screen12563137115620">GET /v1.0/{project_id}/clusters</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table17366174153214" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row1336515493215"><th align="left" class="cellrowborder" valign="top" width="21.059405940594058%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__p1236515416329"><strong id="EN-US_TOPIC_0000001185833140__b2027808278200">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.257425742574258%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__p036584163213"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b6167984116271">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.891089108910892%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__p236524153219"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1152013113134">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.7920792079208%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__p123654417323"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b2080991291316">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row53668412322"><td class="cellrowborder" valign="top" width="21.059405940594058%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p43656413211">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.257425742574258%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p33662423212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.891089108910892%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1736654163219">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.7920792079208%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p103661141329"><span id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_text58654618291">Project ID</span>. For details about how to obtain the project ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__section1576865916134"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001185833140__p7769559151317">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__section2875642103911"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table438132244019" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row73942284014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p539172219406"><strong id="EN-US_TOPIC_0000001185833140__b15137005258200">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p3393224403"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1974121213342">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p12397223402"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b17661346151319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row1239102264014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p18394220409">clusters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p73932294015">Array of <a href="#EN-US_TOPIC_0000001185833140__table1540172224018">ClusterInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p6403222401">List of cluster objects</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1740112254016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p17402225409">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p8401822204019">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1240182294011">Total number of cluster objects</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table1540172224018"></a><a name="table1540172224018"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table1540172224018" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ClusterInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row124018222404"><th align="left" class="cellrowborder" valign="top" width="24.86248624862486%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p5417222404"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b11263192533418">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.432643264326433%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p11411622184014"><strong id="EN-US_TOPIC_0000001185833140__b88445948">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.70487048704871%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p1741622144020"><strong id="EN-US_TOPIC_0000001185833140__b190304154">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row9411622174012"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p124192212409">id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p14120224402">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p8411022144012">Cluster ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1741162218404"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p4411922134019">name</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p124152244016">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p94172212401">Cluster name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row74112254012"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p542102218405">status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p342322114019">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p44222214014">Cluster status. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__ul14210221404"><li id="EN-US_TOPIC_0000001185833140__li6429222406"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706152546">CREATING</strong></li><li id="EN-US_TOPIC_0000001185833140__li124219222403"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b335382630162424">AVAILABLE</strong></li><li id="EN-US_TOPIC_0000001185833140__li342112214019"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706162411">UNAVAILABLE</strong></li><li id="EN-US_TOPIC_0000001185833140__li194218224401"><strong id="EN-US_TOPIC_0000001185833140__b46588003752517">CREATION FAILED</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1642122174017"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1642192215403">version</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p342162210408">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p0431422114020">Data warehouse version</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row144372215403"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p144318229402">updated</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p443162214017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p743162274010">Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row104322264015"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p84312216402">created</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p124352274019">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p19439225404">Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row64342212401"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p143822164016">port</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p643122214401">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p743172211405">Service port of a cluster. The value ranges from 8000 to 30000. The default value is <strong id="EN-US_TOPIC_0000001185833140__b6116415458200">8000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1344142294010"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p19441322204016">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p24402244013">Array of <a href="#EN-US_TOPIC_0000001185833140__table17604221403">Endpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p12445224401">Private network connection information about the cluster.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row19445229404"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1444922154012">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p18442228401">Array of <a href="#EN-US_TOPIC_0000001185833140__table662142218409">Nodes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1544822134015">Cluster instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row134432215404"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p15441422184017">tags</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1441822174019">Array of <a href="#EN-US_TOPIC_0000001185833140__table364132204020">Tags</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p34542216408">Tags in a cluster</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row15451922144019"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p104562224011">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1845222184010">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p10450224404">Administrator username</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row24582214013"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p16451022134018">number_of_node</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p445122274011">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p174517228402">Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row34562224013"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p144517221404">recent_event</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p845522174010">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1046122216401">Number of events</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row12465225404"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p13461822174013">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p046112212408">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p184662217409">AZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row546522184013"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p94652210400">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p746182244011">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p546622144013">Enterprise project ID. The value <strong id="EN-US_TOPIC_0000001185833140__b93096416213">0</strong> indicates the ID of the default enterprise project.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row54612234010"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p164615226407">node_type</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1046112294013">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p54632214406">Node type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row9471122174020"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1147222124014">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p13471122154011">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p44710228402">Specifies the VPC ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row74712254012"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p7471022154011">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p247162254019">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p94719226406">Subnet ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row447162274015"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1047822114015">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p44712284011"><a href="#EN-US_TOPIC_0000001185833140__table13666221406">PublicIp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1048122214017">Public IP address. If the parameter is not specified, public connection is not used by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row048162274012"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1049122124018">public_endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1491221404">Array of <a href="#EN-US_TOPIC_0000001185833140__table16712022184018">PublicEndpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p450222114010">Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row17511722144011"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p55152294020">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1951102219401">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p135292224015">Task information, consisting of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.</p>
<ul id="EN-US_TOPIC_0000001185833140__ul55212254017"><li id="EN-US_TOPIC_0000001185833140__li45214221403">Valid key values include:<ul id="EN-US_TOPIC_0000001185833140__ul952202294010"><li id="EN-US_TOPIC_0000001185833140__li352152234015"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270617363">GROWING</strong></li><li id="EN-US_TOPIC_0000001185833140__li1052112284018"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173523">RESTORING</strong></li><li id="EN-US_TOPIC_0000001185833140__li2521022174013"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173540">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li1052122204013"><strong id="EN-US_TOPIC_0000001185833140__b12288163917238">REPAIRING</strong></li><li id="EN-US_TOPIC_0000001185833140__li65316225401"><strong id="EN-US_TOPIC_0000001185833140__b3106114014236">CREATING</strong></li></ul>
</li><li id="EN-US_TOPIC_0000001185833140__li4535224403">The value indicates the task progress.</li></ul>
<p id="EN-US_TOPIC_0000001185833140__p853102212400">The following is an example:</p>
<pre class="screen" id="EN-US_TOPIC_0000001185833140__screen185310229400">"action_progress":
{"SNAPSHOTTING":"16%"}</pre>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1753132294014"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1953222154015">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p6531022174014">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p195316221401">Sub-status of clusters in the <strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1341008343162427">AVAILABLE</strong> state. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__ul754422164013"><li id="EN-US_TOPIC_0000001185833140__li054022124017"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172235">NORMAL</strong></li><li id="EN-US_TOPIC_0000001185833140__li1754322184016"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b843639795172048">READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__li454122134018"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172246">REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li75410224404"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270617239">REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li1654122211403"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1292667590">UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001185833140__li554022124016"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b843614510919">UNBALANCED | READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__li7541224407"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172436">DEGRADED</strong></li><li id="EN-US_TOPIC_0000001185833140__li0541422124010"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172631">DEGRADED | READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__li1954162216400"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b2481857198">DEGRADED | UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001185833140__li1355152284013"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b750810914103">UNBALANCED | REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li18551221408"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b876417222107">UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li1855132210404"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172941">READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li1455152244012"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1825214361102">UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li9554229402"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173050">DEGRADED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li12551722164018"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270615284">DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li655112284018"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173010">DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__li2056102244015"><strong id="EN-US_TOPIC_0000001185833140__b198055674452517">DEGRADED | UNBALANCED | READONLY</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row10561122164012"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p185632210402">task_status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1561522184014">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p25712234019">Cluster management task. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__ul357322154011"><li id="EN-US_TOPIC_0000001185833140__li19571522144012"><strong id="EN-US_TOPIC_0000001185833140__b953735902">RESTORING</strong></li><li id="EN-US_TOPIC_0000001185833140__li25716223401"><strong id="EN-US_TOPIC_0000001185833140__b1703973736">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li65772274011"><strong id="EN-US_TOPIC_0000001185833140__b1322422890">GROWING</strong></li><li id="EN-US_TOPIC_0000001185833140__li17581222184013"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173642">REBOOTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li17581622124010"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706164634">SETTING_CONFIGURATION</strong></li><li id="EN-US_TOPIC_0000001185833140__li19581822184012"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706164641">CONFIGURING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001185833140__li12586227408"><strong id="EN-US_TOPIC_0000001185833140__b13842196838200">DELETING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001185833140__li175852234019"><strong id="EN-US_TOPIC_0000001185833140__b18075829528200">REBOOT_FAILURE</strong>: Restart failed</li><li id="EN-US_TOPIC_0000001185833140__li12591822184011"><strong id="EN-US_TOPIC_0000001185833140__b248677658200">RESIZE_FAILURE</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row35912264011"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p75915222404">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p15591622194020">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p859192216408">Security group ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row35962254015"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p165952219409">failed_reasons</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p36002213407"><a href="#EN-US_TOPIC_0000001185833140__table5731622114014">FailedReason</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p17601822194011">Cause of failure. If the parameter is left empty, the cluster is in the normal state.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000001185833140__p18608222401"></p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table17604221403"></a><a name="table17604221403"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table17604221403" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Endpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row10601229405"><th align="left" class="cellrowborder" valign="top" width="21.029999999999998%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__p16601822134015"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b193131323204817">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.69%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__p1460142211407"><strong id="EN-US_TOPIC_0000001185833140__b997318904">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.150000000000002%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__p66152211402"><strong id="EN-US_TOPIC_0000001185833140__b158627514">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.13%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__p1611622204010"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b899192201612">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row161202215403"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p0611822164010">connect_info</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p3611822154016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1161142214405">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p14612225403">Private network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row126152284019"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p11627226400">jdbc_url</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p162622144014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1962152254018">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p96215227400">JDBC URL on the private network. The following is the default format:</p>
<p id="EN-US_TOPIC_0000001185833140__p166202244017">jdbc:postgresql://&lt; connect_info&gt;/&lt;YOUR_DATABASE_name&gt;</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table662142218409"></a><a name="table662142218409"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table662142218409" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Nodes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row162192294013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p1363022104011"><strong id="EN-US_TOPIC_0000001185833140__b179316131055">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p163622174019"><strong id="EN-US_TOPIC_0000001185833140__b208074737">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p166314223405"><strong id="EN-US_TOPIC_0000001185833140__b878625325">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row15631722124016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p18637227405">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p7631122124019">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p063422144010">Cluster instance ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1863202244012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1063162254011">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p6633222403">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p166472218408">Cluster instance status</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table364132204020"></a><a name="table364132204020"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table364132204020" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tags</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row9645223404"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p156422244017"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b140195134315">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p15647229401"><strong id="EN-US_TOPIC_0000001185833140__b1992392628">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p1564162264014"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1045515254311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row176522214016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1365192234017">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p665102254018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p126582244013">Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*&lt;&gt;\,|/</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row265102217402"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p765112211402">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p146552254013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p06552234018">Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table13666221406"></a><a name="table13666221406"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table13666221406" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PublicIp</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row1766172212405"><th align="left" class="cellrowborder" valign="top" width="21.484848484848484%" id="mcps1.3.4.8.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__p12661622104012"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b18471425134318">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.323232323232322%" id="mcps1.3.4.8.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__p866722114014"><strong id="EN-US_TOPIC_0000001185833140__b2028377792">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.848484848484851%" id="mcps1.3.4.8.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__p116632213405"><strong id="EN-US_TOPIC_0000001185833140__b1803375140">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.343434343434346%" id="mcps1.3.4.8.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__p2665228407"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b92981151617">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row116662215406"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p2067182212408">public_bind_type</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p186862224014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1470142215404">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p97012274018">Binding type of an EIP. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__ul147022284018"><li id="EN-US_TOPIC_0000001185833140__li107018227408"><strong id="EN-US_TOPIC_0000001185833140__b1629343618200">auto_assign</strong></li><li id="EN-US_TOPIC_0000001185833140__li1470722144017"><strong id="EN-US_TOPIC_0000001185833140__b5141685918200">not_use</strong></li><li id="EN-US_TOPIC_0000001185833140__li6701322144019"><strong id="EN-US_TOPIC_0000001185833140__b14965460268200">bind_existing</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row16701122164018"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p167032244010">eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p671122218402">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1471172204020">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p8711622164019">EIP ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table16712022184018"></a><a name="table16712022184018"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table16712022184018" frame="border" border="1" rules="all"><caption><b>Table 8 </b>PublicEndpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row17721422154019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p472322144014"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b95421012483">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p57216221409"><strong id="EN-US_TOPIC_0000001185833140__b1835130138">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p372202204013"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b15555141819169">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row2072822114010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p3721022124015">public_connect_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p37352212407">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p187316222408">Public network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row173132224019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p19731222144019">jdbc_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1573142264011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1573172234013">JDBC URL of the public network</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table5731622114014"></a><a name="table5731622114014"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table5731622114014" frame="border" border="1" rules="all"><caption><b>Table 9 </b>FailedReason</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row18741722114013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p47420229405"><strong id="EN-US_TOPIC_0000001185833140__b173761515154320">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p1174182212409"><strong id="EN-US_TOPIC_0000001185833140__b727139357">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p10741122164013"><strong id="EN-US_TOPIC_0000001185833140__b191377253430">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row137412220409"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1374122154020">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p07416229407">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1874172234010">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row177412216407"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1575922174010">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p19751022144019">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p13751022164013">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_sf43e64a4061d416caee22c19f8bb1c47"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0000001185833140__screen194716291681">GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_s4a3e14e14b2e46c08af2238496ee149d"><h4 class="sectiontitle">Response example</h4><pre class="screen" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_sc0c0dcd083d441a0b4542e56072985c3">{
"clusters": [
{
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"name": "dws-1",
"status": "AVAILABLE",
"version": "1.2.0",
"updated": "2016-02-10T14:28:14Z",
"created": "2016-02-10T14:26:14Z",
"port": 8000,
"endpoints": [{
"connect_info": "192.168.0.12:8000",
"jdbc_url": "jdbc:postgresql://192.168.0.12:8000/&lt;<em id="EN-US_TOPIC_0000001185833140__i61282051116">YOUR_DATABASE_name</em>&gt;"
}] ,
"nodes" : [ {
"id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
"status" : "200"
}, {
"id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
"status" : "200"
}, {
"id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
"status" : "200"
} ],
"tags":[ {
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}],
"user_name": "dbadmin",
"number_of_node": 3,
"recent_event": 6,
"availability_zone": "eu-de-01",
"enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",
"node_type": "dws.d1.xlarge.ultrahigh",
"vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
"subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
"public_ip": {
"public_bind_type": "auto_assign",
"eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
},
"public_endpoints": [{
"public_connect_info": "10.0.0.8:8000",
"jdbc_url": "jdbc:postgresql://10.0.0.8:8000/&lt;<em id="EN-US_TOPIC_0000001185833140__i786422913162">YOUR_DATABASE_name</em>&gt;"
}],
"action_progress": {"SNAPSHOTTING": "20%"},
"sub_status": "READONLY",
"task_status": "SNAPSHOTTING",
"security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
}],
"count":"2"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_s48e877f46afe4aed93303b04041be848"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001387179348_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row691285951318"><th align="left" class="cellrowborder" valign="top" width="14.97%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001185833140__p17853071410">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85.03%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001185833140__p3854012142"><strong id="EN-US_TOPIC_0000001185833140__b1432144933">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row0912125911318"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p68511015142">200</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p2858010141">The cluster list is queried.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1591265919133"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p78500161419">400</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p198510201415">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row6912145901310"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p138514011414">401</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p9851051416">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row891255951315"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p086306142">403</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p19861205140">You do not have required permissions.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row12912195971311"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1486805149">404</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p20861804143">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row89136592132"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p2863011410">500</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p786005143">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row11913135971312"><td class="cellrowborder" valign="top" width="14.97%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__p78616015143">503</p>
</td>
<td class="cellrowborder" valign="top" width="85.03%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__p3861012143">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Managing Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink