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 b974c4b77e DWS API 2022101001 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2022-12-12 18:34:53 +00:00

498 lines
57 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001224724187"></a><a name="EN-US_TOPIC_0000001224724187"></a>
<h1 class="topictitle1">Querying the Cluster List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_s7824f9daa8b546c086192e45721e6e61"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_s18625cd3bdc8450a85dc8bff5ee9c3ab"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_ul52155720"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li66748299">URI format<pre class="screen" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_screen12563137115620">GET /v1.0/{project_id}/clusters</pre>
</li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li5583857">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p233791391059"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_a0cfb8bbe0a624f0585b5905a7a8f6600"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_a7d75ef22fef942ed8e6357de65c2879c"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p950656191059"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b2080991291316">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_p741273422514"><span id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_sf43e64a4061d416caee22c19f8bb1c47"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p13517702">Request example</p>
<pre class="screen" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_s994678d6fd6b4db9bbde391057394bed">GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_s4a3e14e14b2e46c08af2238496ee149d"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_ul63988077"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li39021788">Example response<pre class="screen" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_sc0c0dcd083d441a0b4542e56072985c3">{
"clusters": [
{
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"status": "AVAILABLE",
"sub_status": "READONLY",
"task_status": "SNAPSHOTTING",
"action_progress": {"SNAPSHOTTING": "20%"},
"node_type": "dws.d1.xlarge.ultrahigh",
"subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
"security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
"number_of_node": 3,
"availability_zone": "eu-de-01",
"port": 8000,
"name": "dws-1",
"version": "1.2.0",
"vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
"user_name": "dbadmin",
"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_0000001224724187__en-us_topic_0000001145696539_i9341521102115">YOUR_DATABASE_name</em>&gt;"
}
],
"endpoints": [
{
"connect_info": "192.168.0.12:8000",
"jdbc_url": "jdbc:postgresql://192.168.0.12:8000/&lt;<em id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_i1179951772110">YOUR_DATABASE_name</em>&gt;"
}
] ,
"updated": "2016-02-10T14:28:14Z",
"created": "2016-02-10T14:26:14Z",
"enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",
"recent_event": 6
"tags":[
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
],
}
],
"count":"2"
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_ul56511253"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li38839231">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row20540626161916"><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_0000001224724187__en-us_topic_0000001145696539_p115431262191"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_p105441526141918"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_p154402631913"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b17661346151319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row7540102614198"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p854502615198">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_0000001224724187__en-us_topic_0000001145696539_p8545142619196">Array of <a href="#EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_p1054622651919">List of cluster objects</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__row723654512612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__p42377454260">Total number of cluster objects</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1040710342519"></a><a name="en-us_topic_0000001145696539_table1040710342519"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_row144128341859"><th align="left" class="cellrowborder" valign="top" width="19.74197419741974%" id="mcps1.3.4.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p64881223268"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b11263192533418">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.212021202120212%" id="mcps1.3.4.3.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p114891923461"><strong id="EN-US_TOPIC_0000001224724187__b813810923">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.046004600460044%" id="mcps1.3.4.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1348962320613"><strong id="EN-US_TOPIC_0000001224724187__b1322015002">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row041283419515"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p14489923266">id</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p248913231161">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1948952316613">Cluster ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1741316341557"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p249014231162">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1749082313616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p11490102317615">Cluster status. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_ul7490182316610"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li7490102312611"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706152546">CREATING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li84901123562"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b335382630162424">AVAILABLE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1349014231364"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706162411">UNAVAILABLE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li20490202314614"><strong id="EN-US_TOPIC_0000001224724187__b46588003752517">CREATION FAILED</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row104157341516"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p19506416072">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p050741612718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p450813161078">Sub-status of clusters in the <strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b1341008343162427">AVAILABLE</strong> state. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_ul75090161972"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li9509201613711"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706172235">NORMAL</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li45097165712"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b843639795172048">READONLY</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1550914163719"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706172246">REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li95101516973"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b84235270617239">REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li105107164720"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b1292667590">UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li9510151616720"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b843614510919">UNBALANCED | READONLY</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li6510171619713"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706172436">DEGRADED</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1351051615713"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706172631">DEGRADED | READONLY</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li125111516375"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b2481857198">DEGRADED | UNBALANCED</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li951118161677"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b750810914103">UNBALANCED | REDISTRIBUTING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1251161611717"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b876417222107">UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li551215161476"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706172941">READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li6512181616713"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b1825214361102">UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1451241617715"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173050">DEGRADED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li155129161279"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b84235270615284">DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1651317161718"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173010">DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li95131916379"><strong id="EN-US_TOPIC_0000001224724187__b198055674452517">DEGRADED | UNBALANCED | READONLY</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row134150349519"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p0904496710">task_status</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p149054916711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p59012499716">Cluster management task. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_ul1090749976"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li69110498717"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173523">RESTORING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li2913494712"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173540">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li189117492712"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b84235270617363">GROWING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li16916493711"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173642">REBOOTING</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li13914496712"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706164634">SETTING_CONFIGURATION</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li1191114917718"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706164641">CONFIGURING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li4911549673"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706164649">DELETING_EXT_DATASOURCE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li29219491971"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b842352706173725">REBOOT_FAILURE</strong></li><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_li19211496716"><strong id="EN-US_TOPIC_0000001224724187__b177498235652517">RESIZE_FAILURE</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row134161334454"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1636752513811">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p536710251085">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__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_0000001224724187__ul3241173110216"><li id="EN-US_TOPIC_0000001224724187__li2019414233810">Valid key values include:<ul id="EN-US_TOPIC_0000001224724187__ul29081947103819"><li id="EN-US_TOPIC_0000001224724187__li18195442143816"><strong id="EN-US_TOPIC_0000001224724187__b1263532540">GROWING</strong></li><li id="EN-US_TOPIC_0000001224724187__li71951042113810"><strong id="EN-US_TOPIC_0000001224724187__b1892230564">RESTORING</strong></li><li id="EN-US_TOPIC_0000001224724187__li11195642133817"><strong id="EN-US_TOPIC_0000001224724187__b1925342530">SNAPSHOTTING</strong></li><li id="EN-US_TOPIC_0000001224724187__li16195114216382"><strong id="EN-US_TOPIC_0000001224724187__b13693530142518">REPAIRING</strong></li><li id="EN-US_TOPIC_0000001224724187__li719617421389"><strong id="EN-US_TOPIC_0000001224724187__b1949111353254">CREATING</strong></li></ul>
</li><li id="EN-US_TOPIC_0000001224724187__li8196042153816">The value indicates the task progress.</li></ul>
<p id="EN-US_TOPIC_0000001224724187__p42410319210">Example:</p>
<pre class="screen" id="EN-US_TOPIC_0000001224724187__screen1324133119217">"action_progress":
{"SNAPSHOTTING":"16%"}</pre>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1441614341759"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p102741646298">node_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p192741146991">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1727494610914">Node type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row204161834352"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p86431418141014">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p06441818141017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p764416182102">Subnet ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1541617344519"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1493614466102">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p18937164617102">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p494604631017">Security group ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row24177341159"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p139435016118">number_of_node</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p7941650101110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_row541710341753"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p72821064123">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p22821866124">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p62829661212">AZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row84171734651"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1108203915125">port</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1109239181218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p7109133919122">Service port of a cluster. The value ranges from 8000 to 30000. The default value is <strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b172784398185">8000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row144180341851"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p11571151441310">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p65711314191319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p65712014121313">Cluster name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row34186347512"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1167365013133">version</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p967325021312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p7674350201317">Data warehouse version</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1241819340517"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p93744181517">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p137416113156">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p63742018151">VPC ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1419163414519"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p145561123121512">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p165570238150">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p17557132341513">Cluster administrator name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row2041918345517"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p122086181610">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p16208691612"><a href="#EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1369174212104">PublicIp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p421965166">Public IP address. If the parameter is not specified, public connection is not used by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1841917341054"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p51562916174">public_endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__p4484114820149">Array of <a href="#EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_public_endpoints">PublicEndpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1816202931713">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_0000001224724187__en-us_topic_0000001145696539_row44201934153"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p174611335161914">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1461103514199">Array of <a href="#EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1429517815131">Endpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p13461835151911">Private network connection information about the cluster.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1742053419510"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p11578186152112">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p95789622115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p135782611214">Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1142118341510"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p18839324142111">created</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1484022413218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p984052414216">Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row17422434154"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p3860164919218">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p15860114916211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1386034972113">Enterprise project ID. The value <strong id="EN-US_TOPIC_0000001224724187__b29867205252517">0</strong> indicates the ID of the default enterprise project.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row74221348512"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p159911848122411">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p149926484242">Array of <a href="#EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_tags">Tags</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p179921948192417">Tags in a cluster</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row174231348512"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p10688142310250">recent_event</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p15689192310255">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p168902315259">Number of events</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row124241934259"><td class="cellrowborder" valign="top" width="19.74197419741974%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p18888155092519">failed_reasons</p>
</td>
<td class="cellrowborder" valign="top" width="20.212021202120212%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__p443824811148"><a href="#EN-US_TOPIC_0000001224724187__response_FailedReason">FailedReason</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60.046004600460044%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__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>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1369174212104"></a><a name="en-us_topic_0000001145696539_table1369174212104"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1369174212104" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PublicIp</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row16923428102"><th align="left" class="cellrowborder" valign="top" width="21.484848484848484%" id="mcps1.3.4.3.1.3.2.5.1.1"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p569212423109"><strong id="EN-US_TOPIC_0000001224724187__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.3.2.5.1.2"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p669215427104"><strong id="EN-US_TOPIC_0000001224724187__b144153822">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.848484848484851%" id="mcps1.3.4.3.1.3.2.5.1.3"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p169294251013"><strong id="EN-US_TOPIC_0000001224724187__b1283460792">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.343434343434346%" id="mcps1.3.4.3.1.3.2.5.1.4"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p14692242151019"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b92981151617">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row15692104210106"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.3.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p569214216108">public_bind_type</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.3.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1069254218101">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.3.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p8692204212100">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.3.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001224724187__p10825429174912">Binding type of an EIP. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001224724187__ul1482562974920"><li id="EN-US_TOPIC_0000001224724187__li88251329184918"><strong id="EN-US_TOPIC_0000001224724187__b19178161618416"><span id="EN-US_TOPIC_0000001224724187__ph7319509413">auto_assign</span></strong></li><li id="EN-US_TOPIC_0000001224724187__li1224625212133"><strong id="EN-US_TOPIC_0000001224724187__b8706121113414">not_use</strong></li><li id="EN-US_TOPIC_0000001224724187__li11155202914139"><strong id="EN-US_TOPIC_0000001224724187__b15479131310418">bind_existing</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row469374291013"><td class="cellrowborder" valign="top" width="21.484848484848484%" headers="mcps1.3.4.3.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p969364211103">eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.323232323232322%" headers="mcps1.3.4.3.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p3693142181013">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.848484848484851%" headers="mcps1.3.4.3.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p669394291014">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.343434343434346%" headers="mcps1.3.4.3.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p13693174210103">EIP ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_tags"></a><a name="en-us_topic_0000001145696539_response_tags"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_tags" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Tags</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row1660842612190"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p761017261197"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b140195134315">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p136101126121911"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b2704451104318">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p18611112611194"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b1045515254311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row860992651919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p17611226101910">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1661142616194">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p66121426141911">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_0000001224724187__en-us_topic_0000001145696539_row3609192617191"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1961232641911">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1612726131914">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p10613122681914">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 cannot contain the following characters: =*&lt;&gt;\,|/</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_public_endpoints"></a><a name="en-us_topic_0000001145696539_response_public_endpoints"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_response_public_endpoints" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PublicEndpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row4614826201918"><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_0000001224724187__en-us_topic_0000001145696539_p2615526111915"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b95421012483">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_0000001224724187__en-us_topic_0000001145696539_p1661514260192"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b13288611114812">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_0000001224724187__en-us_topic_0000001145696539_p13616132661915"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b15555141819169">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row461482631911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p176163267192">public_connect_info</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_0000001224724187__en-us_topic_0000001145696539_p4617192601914">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_0000001224724187__en-us_topic_0000001145696539_p3617182620198">Public network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row13614102619197"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1617152611911">jdbc_url</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_0000001224724187__en-us_topic_0000001145696539_p46203269196">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_0000001224724187__en-us_topic_0000001145696539_p156241626191916">JDBC URL of the public network</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1429517815131"></a><a name="en-us_topic_0000001145696539_table1429517815131"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_table1429517815131" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Endpoints</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row172962815138"><th align="left" class="cellrowborder" valign="top" width="21.029999999999998%" id="mcps1.3.4.3.1.6.2.5.1.1"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p3296108191317"><strong id="EN-US_TOPIC_0000001224724187__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.6.2.5.1.2"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p112962816137"><strong id="EN-US_TOPIC_0000001224724187__b1590997460">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.150000000000002%" id="mcps1.3.4.3.1.6.2.5.1.3"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p729618181314"><strong id="EN-US_TOPIC_0000001224724187__b1844116440">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.13%" id="mcps1.3.4.3.1.6.2.5.1.4"><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p13296158131312"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b899192201612">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row102961861313"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.3.1.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p142961881130">connect_info</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.3.1.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p92969818135">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.3.1.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p32971482136">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.3.1.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p102976881314">Private network connection information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_row14297089136"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.4.3.1.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p16297158111320">jdbc_url</p>
</td>
<td class="cellrowborder" valign="top" width="9.69%" headers="mcps1.3.4.3.1.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p4297481138">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.4.3.1.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p162979811319">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.4.3.1.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p1629715820133">JDBC URL on the private network. The following is the default format:</p>
<p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_p129788141310">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_0000001224724187__response_FailedReason"></a><a name="response_FailedReason"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__response_FailedReason" frame="border" border="1" rules="all"><caption><b>Table 8 </b>FailedReason</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__row0497048181419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.7.2.4.1.1"><p id="EN-US_TOPIC_0000001224724187__p44981348121419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.7.2.4.1.2"><p id="EN-US_TOPIC_0000001224724187__p449954816142"><strong id="EN-US_TOPIC_0000001224724187__b1346383729">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.7.2.4.1.3"><p id="EN-US_TOPIC_0000001224724187__p19499144817145">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__row12497124818144"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__p17500194810140">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__p550154810142">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__p9501204861411">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__row144971148141413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001224724187__p1550244831419">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001224724187__p95031548121418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001224724187__p1350419481149">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_s48e877f46afe4aed93303b04041be848"><h4 class="sectiontitle">Returned Value</h4><ul id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_ul31979016"><li id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li19375690">Normal<p id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p40163483"><a name="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_li25927028">Exception
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_table32016662" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Returned values</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p61434729"><strong id="EN-US_TOPIC_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p10157186"><strong id="EN-US_TOPIC_0000001224724187__en-us_topic_0000001145696539_b31981737101615">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p43909159">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p33461405">Authorization failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p43330072">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p4892154">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__en-us_topic_0000001145696539_en-us_topic_0067607266_p40297137">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001224724187__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_0000001224724187__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_0000001224724187__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