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 3d88b677fd DWS API 830.201 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-05-10 13:18:08 +00:00

535 lines
56 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><ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_ul52155720"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li66748299">URI format<pre class="screen" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_screen12563137115620">GET /v1.0/{project_id}/clusters</pre>
</li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li5583857">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_t575c11e12d424496a5ee5f1e21aed0eb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_r1ae71c4bc7904106878ea7fc6f67ceac"><th align="left" class="cellrowborder" valign="top" width="21.059405940594058%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p233791391059"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270617228">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.257425742574258%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_a0cfb8bbe0a624f0585b5905a7a8f6600"><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.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_a7d75ef22fef942ed8e6357de65c2879c"><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.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p950656191059"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b2080991291316">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row841253413255"><td class="cellrowborder" valign="top" width="21.059405940594058%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p104124345257">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.257425742574258%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p541223418251">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.891089108910892%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p94122034102519">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.7920792079208%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p741273422514"><span id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_text58654618291">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_sf43e64a4061d416caee22c19f8bb1c47"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p13517702">Request example</p>
<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</h4><ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_ul63988077"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li39021788">Example response<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<span id="EN-US_TOPIC_0000001185833140__ph1610542981317">,</span>
"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>
</li></ul>
<ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_ul56511253"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li38839231">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table11983306226" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row139863019221"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p69893013223"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b33661514133411">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p998830142215"><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.3.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p098163019222"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b17661346151319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row598530152213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1999030182219">clusters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p12999303226">Array of <a href="#EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_table1040710342519">ClusterInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p3991830132216">List of cluster objects</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row723654512612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1420174811145">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p16237184582615">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p51901923193718">Total number of cluster objects</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_table1040710342519"></a><a name="en-us_topic_0000001145696539_table1040710342519"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_table1040710342519" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ClusterInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row144128341859"><th align="left" class="cellrowborder" valign="top" width="24.86248624862486%" id="mcps1.3.4.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p64881223268"><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.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p114891923461"><strong id="EN-US_TOPIC_0000001185833140__b1354431788">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.70487048704871%" id="mcps1.3.4.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p1348962320613"><strong id="EN-US_TOPIC_0000001185833140__b31509467">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row041283419515"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p14489923266">id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p248913231161">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p1948952316613">Cluster ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row18386133214531"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p12261334185315">name</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p5226203405319">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p14226334115315">Cluster name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row1741316341557"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p249014231162">status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p1749082313616">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p11490102317615">Cluster status. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_ul7490182316610"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li7490102312611"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706152546">CREATING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li84901123562"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b335382630162424">AVAILABLE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1349014231364"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706162411">UNAVAILABLE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li20490202314614"><strong id="EN-US_TOPIC_0000001185833140__b46588003752517">CREATION FAILED</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1834065335317"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p18135197135417">version</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p213517125411">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p9135971541">Data warehouse version</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row34004225547"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p18997136115514">updated</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p3997186195516">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p189970675516">Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1020012268540"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p899715617559">created</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1299712619553">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p159971769557">Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row98461037185412"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p163111219155512">port</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p153114198553">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p9311131995513">Service port of a cluster. The value ranges from 8000 to 30000. The default value is <strong id="EN-US_TOPIC_0000001185833140__b65655306547">8000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row2509826105518"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p196241448135515">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p18624948195512">Array of <a href="#EN-US_TOPIC_0000001185833140__table5424631742">Endpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p2625164814550">Private network connection information about the cluster.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row20740230175516"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1930882813813">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p15309142818813">Array of <a href="#EN-US_TOPIC_0000001185833140__response_Nodes">Nodes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p9310528786">Cluster Instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1020384005618"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p11551830570">tags</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p11552320573">Array of <a href="#EN-US_TOPIC_0000001185833140__table158712347513">Tags</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p31551838577">Tags in a cluster</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1187614305612"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p3131032115717">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p111318324573">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p17139324571">Username of the administrator</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row14937173716578"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p6485161755816">number_of_node</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p2485141710586">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001098816618_p285313823113">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__row32312482572"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1637923755819">recent_event</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p17379143715582">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1837923713580">Number of events</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row9132359115819"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p15284175035910">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p328495095913">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p19285175015598">AZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row11868046595"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p73681151904">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p163681752013">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p33681156013">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__row14778915593"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p11389408012">node_type</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p83815401106">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p43818403013">Node type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row652011411599"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1325912558018">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p3259155514016">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p425975520017">VPC ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row31536195595"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p121842915111">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p16184199615">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p5184691119">Subnet ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row18646241591"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p151986241116">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1419819241517"><a href="#EN-US_TOPIC_0000001185833140__table1183155413517">PublicIp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p4199172412112">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__row1435622919593"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1629014387115">public_endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p22904381115">Array of <a href="#EN-US_TOPIC_0000001185833140__table14398151017610">PublicEndpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1029014385120">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__row16209161712218"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p12240133110216">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1924016311524">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p4240731626">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__ul3241173110216"><li id="EN-US_TOPIC_0000001185833140__li2019414233810">Valid key values include:<ul id="EN-US_TOPIC_0000001185833140__ul29081947103819"><li id="EN-US_TOPIC_0000001185833140__li18195442143816"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270617363">GROWING</strong></li><li id="EN-US_TOPIC_0000001185833140__li71951042113810"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173523">RESTORING</strong></li><li id="EN-US_TOPIC_0000001185833140__li11195642133817"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173540">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001185833140__li16195114216382"><strong id="EN-US_TOPIC_0000001185833140__b12288163917238">REPAIRING</strong></li><li id="EN-US_TOPIC_0000001185833140__li719617421389"><strong id="EN-US_TOPIC_0000001185833140__b3106114014236">CREATING</strong></li></ul>
</li><li id="EN-US_TOPIC_0000001185833140__li8196042153816">The value indicates the task progress.</li></ul>
<p id="EN-US_TOPIC_0000001185833140__p42410319210">The following is an example:</p>
<pre class="screen" id="EN-US_TOPIC_0000001185833140__screen1324133119217">"action_progress":
{"SNAPSHOTTING":"16%"}</pre>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row104157341516"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p19506416072">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p050741612718">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p450813161078">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__en-us_topic_0000001145696539_ul75090161972"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li9509201613711"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172235">NORMAL</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li45097165712"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b843639795172048">READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1550914163719"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172246">REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li95101516973"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270617239">REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li105107164720"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1292667590">UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li9510151616720"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b843614510919">UNBALANCED | READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li6510171619713"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172436">DEGRADED</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1351051615713"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172631">DEGRADED | READONLY</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li125111516375"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b2481857198">DEGRADED | UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li951118161677"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b750810914103">UNBALANCED | REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1251161611717"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b876417222107">UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li551215161476"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706172941">READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li6512181616713"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1825214361102">UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1451241617715"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173050">DEGRADED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li155129161279"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b84235270615284">DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1651317161718"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173010">DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li95131916379"><strong id="EN-US_TOPIC_0000001185833140__b198055674452517">DEGRADED | UNBALANCED | READONLY</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row134150349519"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p0904496710">task_status</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p149054916711">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p59012499716">Cluster management task. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_ul1090749976"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li69110498717"><strong id="EN-US_TOPIC_0000001185833140__b900718197">RESTORING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li2913494712"><strong id="EN-US_TOPIC_0000001185833140__b426164393">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li189117492712"><strong id="EN-US_TOPIC_0000001185833140__b1199580472">GROWING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li16916493711"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173642">REBOOTING</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li13914496712"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706164634">SETTING_CONFIGURATION</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li1191114917718"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706164641">CONFIGURING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li4911549673"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706164649">DELETING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li29219491971"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706173725">REBOOT_FAILURE</strong></li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_li19211496716"><strong id="EN-US_TOPIC_0000001185833140__b177498235652517">RESIZE_FAILURE</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row1541617344519"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p1493614466102">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p18937164617102">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p494604631017">Security group ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_row124241934259"><td class="cellrowborder" valign="top" width="24.86248624862486%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p18888155092519">failed_reasons</p>
</td>
<td class="cellrowborder" valign="top" width="26.432643264326433%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1435013171388"><a href="#EN-US_TOPIC_0000001185833140__response_FailedReason">FailedReason</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="48.70487048704871%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_p1888845072519">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__p1079119115418"></p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table5424631742"></a><a name="table5424631742"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table5424631742" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Endpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row7425123540"><th align="left" class="cellrowborder" valign="top" width="21.029999999999998%" id="mcps1.3.4.3.1.4.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__p9425331843"><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.3.1.4.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__p8425534414"><strong id="EN-US_TOPIC_0000001185833140__b1692643225">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.150000000000002%" id="mcps1.3.4.3.1.4.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__p11425330416"><strong id="EN-US_TOPIC_0000001185833140__b1807309037">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.13%" id="mcps1.3.4.3.1.4.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__p114261231149"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b899192201612">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row12426531549"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.3.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1542783144">connect_info</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.3.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p44271831415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.3.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p64276314410">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.3.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p3427931747">Private network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1642712313417"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.3.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p20428231243">jdbc_url</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.3.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p124281311411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.3.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p44282034411">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.3.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p842819318418">JDBC URL on the private network. The following is the default format:</p>
<p id="EN-US_TOPIC_0000001185833140__p742810313418">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__response_Nodes"></a><a name="response_Nodes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__response_Nodes" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Nodes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row11378128088"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.5.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p19380928182"><strong id="EN-US_TOPIC_0000001185833140__b179316131055">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p73813281783"><strong id="EN-US_TOPIC_0000001185833140__b1744379669">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p153825287811"><strong id="EN-US_TOPIC_0000001185833140__b684256963">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row5378152812820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p183838281788">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1338311285811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p638418281986">Cluster instance ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row53795285816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p133855281387">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p173866289820">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p163864285812">Cluster instance status</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table158712347513"></a><a name="table158712347513"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table158712347513" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tags</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row1871434157"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.6.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p08715341955"><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.3.1.6.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p168727348513"><strong id="EN-US_TOPIC_0000001185833140__b1685597851">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.6.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p13872134456"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b1045515254311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row38721834654"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p12872133411510">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p178721534057">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1887213349516">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__row19872173416515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p487233419514">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p168729341556">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p158721234851">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__table1183155413517"></a><a name="table1183155413517"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table1183155413517" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PublicIp</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row81841054956"><th align="left" class="cellrowborder" valign="top" width="21.484848484848484%" id="mcps1.3.4.3.1.7.2.5.1.1"><p id="EN-US_TOPIC_0000001185833140__p13184254553"><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.3.1.7.2.5.1.2"><p id="EN-US_TOPIC_0000001185833140__p181841054552"><strong id="EN-US_TOPIC_0000001185833140__b1644749039">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.848484848484851%" id="mcps1.3.4.3.1.7.2.5.1.3"><p id="EN-US_TOPIC_0000001185833140__p118518549512"><strong id="EN-US_TOPIC_0000001185833140__b423522396">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.343434343434346%" id="mcps1.3.4.3.1.7.2.5.1.4"><p id="EN-US_TOPIC_0000001185833140__p1318520549515"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b92981151617">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row41851654051"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.3.1.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p131859541851">public_bind_type</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.3.1.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p14185354254">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.3.1.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p8185754657">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.3.1.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p318518541452">Binding type of an EIP. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001185833140__ul13185125416514"><li id="EN-US_TOPIC_0000001185833140__li151864541351"><span id="EN-US_TOPIC_0000001185833140__ph1223504134311">auto_assign</span></li><li id="EN-US_TOPIC_0000001185833140__li31861054354"><strong id="EN-US_TOPIC_0000001185833140__b635613512432">not_use</strong></li><li id="EN-US_TOPIC_0000001185833140__li1218614541557"><strong id="EN-US_TOPIC_0000001185833140__b2296186154320">bind_existing</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row1618620541252"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.3.1.7.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833140__p1418675412512">eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.3.1.7.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833140__p1718610541659">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.3.1.7.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833140__p7186175413519">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.3.1.7.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833140__p20186354555">EIP ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__table14398151017610"></a><a name="table14398151017610"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__table14398151017610" frame="border" border="1" rules="all"><caption><b>Table 8 </b>PublicEndpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row03995109615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.8.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p13399210864"><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.3.1.8.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p1140011107617"><strong id="EN-US_TOPIC_0000001185833140__b601143145">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.8.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p340018101568"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b15555141819169">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row84004100610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p184004107615">public_connect_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p104001610063">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p144001410366">Public network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row140014102618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p14002101563">jdbc_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p16401910463">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1440119107616">JDBC URL of the public network</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833140__response_FailedReason"></a><a name="response_FailedReason"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__response_FailedReason" frame="border" border="1" rules="all"><caption><b>Table 9 </b>FailedReason</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__row15392217684"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.9.2.4.1.1"><p id="EN-US_TOPIC_0000001185833140__p739418171187"><strong id="EN-US_TOPIC_0000001185833140__b173761515154320">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.9.2.4.1.2"><p id="EN-US_TOPIC_0000001185833140__p1939591718816"><strong id="EN-US_TOPIC_0000001185833140__b1255727910">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.9.2.4.1.3"><p id="EN-US_TOPIC_0000001185833140__p1339613176811"><strong id="EN-US_TOPIC_0000001185833140__b191377253430">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__row133931717089"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p739691715819">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p739710171083">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p9398171711812">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__row73931717888"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833140__p5399317983">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833140__p139921712811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833140__p1340018171189">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_s48e877f46afe4aed93303b04041be848"><h4 class="sectiontitle">Returned Value</h4><ul id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_ul31979016"><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li19375690">Normal<p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p40163483"><a name="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li19375690"></a><a name="en-us_topic_0000001145696539_en-us_topic_0067607266_li19375690"></a>200</p>
</li><li id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_li25927028">Exception
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_table32016662" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Returned values</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row28099101"><th align="left" class="cellrowborder" valign="top" width="32.300000000000004%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p61434729"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b842352706175024">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.7%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p10157186"><strong id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_b31981737101615">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row17425743"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p2199097">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p43909159">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row66980994"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p56751409">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p33461405">Authorization failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row32717189"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p32846614">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p43330072">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row54426330"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p46456648">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p4892154">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row44029393"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p9611044">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p40297137">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_row27129916"><td class="cellrowborder" valign="top" width="32.300000000000004%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p50039568">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="67.7%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001185833140__en-us_topic_0000001145696539_en-us_topic_0067607266_p26673201">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Cluster Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink