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

379 lines
33 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001231272825"></a><a name="EN-US_TOPIC_0000001231272825"></a>
<h1 class="topictitle1">Creating a Cluster</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_scd66d518a80c4ea88a94f13aa57bb1e1"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_en-us_topic_0067607268_p36702580">This API is used to create clusters.</p>
<p id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_p95315409566">The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.</p>
<p id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_p1594471275719">This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_see3b10011fa94758b8bc201af3e10d11"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_screen0731836155511">POST /v1.0/{project_id}/clusters</pre>
<div class="p" id="EN-US_TOPIC_0000001231272825__p3662152712213">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table10703119724" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row16702791625"><th align="left" class="cellrowborder" valign="top" width="19.27%" id="mcps1.3.2.3.1.2.5.1.1"><p id="EN-US_TOPIC_0000001231272825__p1170109527"><strong id="EN-US_TOPIC_0000001231272825__b3511446548208">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.96%" id="mcps1.3.2.3.1.2.5.1.2"><p id="EN-US_TOPIC_0000001231272825__p87021991526"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b6167984116271">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.68%" id="mcps1.3.2.3.1.2.5.1.3"><p id="EN-US_TOPIC_0000001231272825__p127021591925"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b19825185211810">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.089999999999996%" id="mcps1.3.2.3.1.2.5.1.4"><p id="EN-US_TOPIC_0000001231272825__p5702390218"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b59291959920">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row97031291023"><td class="cellrowborder" valign="top" width="19.27%" headers="mcps1.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p16702209524">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.96%" headers="mcps1.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p207021491722">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.68%" headers="mcps1.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p157021094220">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.089999999999996%" headers="mcps1.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p127031492023"><span id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_text36532162818">Project ID</span>. For details about how to obtain the project ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__section93041431289"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table749619184288" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row8497141862811"><th align="left" class="cellrowborder" valign="top" width="18.911891189118908%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001231272825__p184982188281"><strong id="EN-US_TOPIC_0000001231272825__b8305567338208">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.03100310031003%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001231272825__p2498121813282"><strong id="EN-US_TOPIC_0000001231272825__b1476873430">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.821382138213819%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001231272825__p154982018132816"><strong id="EN-US_TOPIC_0000001231272825__b955008431">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.23572357235723%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001231272825__p54981618182813"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b220417480914">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row4498118172817"><td class="cellrowborder" valign="top" width="18.911891189118908%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p184981118132815">cluster</p>
</td>
<td class="cellrowborder" valign="top" width="10.03100310031003%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p6498181814283">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.821382138213819%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p5499171811285"><a href="#EN-US_TOPIC_0000001231272825__table1649981882819">CreateClusterInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="57.23572357235723%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1149919187282">Cluster object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001231272825__table1649981882819"></a><a name="table1649981882819"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table1649981882819" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateClusterInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row549921820282"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001231272825__p1349981816284"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b84235270617228">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001231272825__p1949961862816"><strong id="EN-US_TOPIC_0000001231272825__b43433861">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001231272825__p3500151862820"><strong id="EN-US_TOPIC_0000001231272825__b1892953174">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001231272825__p1550061810285"><strong id="EN-US_TOPIC_0000001231272825__b1000944556">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row150021852818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1450001816284">node_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p20500111862817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p185009186285">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1350021818285">Node type </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row150017189283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1150017185284">number_of_node</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p750111182281">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1150113189282">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1450151842813">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_0000001231272825__row7501518122815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1650111812816">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1250161892818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p11501131811283">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p6501918152818">Subnet ID, which is used for configuring cluster network.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row35011418172817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p4502131842810">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p15026183284">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p65021418192810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p8502318182810">ID of a security group, which is used for configuring cluster network.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row11502318182813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p450281832818">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p4503191862818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p350351818287">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p195035185289">VPC ID, which is used for configuring cluster network.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row450331832811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p175031418142818">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p7503131812288">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1950321872820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p6504121810289">AZ of a cluster </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row850418188285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1550419186285">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p165041218112815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p350451862816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p15505141815284">Service port of a cluster. The value ranges from 8000 to 30000. The default value is <strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b13647419274">8000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row950515188284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p6505101892815">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p175051018172810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p15057180281">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1950551810284">Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row2505191810284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p18505518112810">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p105061418192811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p20506118122813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1950661811285">Administrator username for logging in to a GaussDB(DWS) cluster. The administrator username must:</p>
<ul id="EN-US_TOPIC_0000001231272825__ul850619183282"><li id="EN-US_TOPIC_0000001231272825__li10506121892810">Consist of lowercase letters, digits, or underscores.</li><li id="EN-US_TOPIC_0000001231272825__li250619183282">Start with a lowercase letter or an underscore.</li><li id="EN-US_TOPIC_0000001231272825__li15507318102814">Contain 1 to 63 characters.</li><li id="EN-US_TOPIC_0000001231272825__li350751852816">Cannot be a keyword of the GaussDB(DWS) database.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row13507191817288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1450713183281">user_pwd</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p250751842810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1507111862816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p175071187289">Administrator password for logging in to a GaussDB(DWS) cluster</p>
<ul id="EN-US_TOPIC_0000001231272825__ul18508171872817"><li id="EN-US_TOPIC_0000001231272825__li75084185281">Contains 12 to 32 characters.</li><li id="EN-US_TOPIC_0000001231272825__li550841872814">Contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!?, .:;-_(){}[]/&lt;&gt;@# %^&amp;*+|\=).</li><li id="EN-US_TOPIC_0000001231272825__li95081518162815">Cannot be the same as the username or the username written in reverse order.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row145081618172817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p150918183286">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p18509121852820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p175091318122820"><a href="#EN-US_TOPIC_0000001231272825__table165101918182811">PublicIp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p85091818122815">Public IP address. If the parameter is not specified, public connection is not used by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row45092188282"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p18509161813284">number_of_cn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p6509418182818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p450931812812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p14509141813285">Number of deployed CNs. The value ranges from 2 to the number of cluster nodes. The maximum value is <strong id="EN-US_TOPIC_0000001231272825__b233062016364">20</strong> and the default value is <strong id="EN-US_TOPIC_0000001231272825__b13361520183613">3</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row15509121813283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p17509181812820">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p2510161832820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p165101018102812"><a href="#EN-US_TOPIC_0000001231272825__table0514518112818">Tags</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p195101618202811">Label.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row1851012189283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1751081815288">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p10510131872815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1551081892816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p551011812289">Enterprise project. The default enterprise project ID is <strong id="EN-US_TOPIC_0000001231272825__b45701011552437">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001231272825__table165101918182811"></a><a name="table165101918182811"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table165101918182811" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PublicIp</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row5511201862820"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001231272825__p1451151822818"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b2187112353217">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001231272825__p17511131842811"><strong id="EN-US_TOPIC_0000001231272825__b621094573">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001231272825__p18512018172820"><strong id="EN-US_TOPIC_0000001231272825__b1519132683">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001231272825__p1151291814282"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b88588134101">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row15512201842811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p4512191822816">public_bind_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p351331813280">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p3513131818288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p3513018192814">Binding type of an EIP. The value can be one of the following:</p>
<ul id="EN-US_TOPIC_0000001231272825__ul155131818112811"><li id="EN-US_TOPIC_0000001231272825__li651311182288"><span id="EN-US_TOPIC_0000001231272825__ph129803774410">auto_assign</span></li><li id="EN-US_TOPIC_0000001231272825__li15513111817287"><strong id="EN-US_TOPIC_0000001231272825__b1840814226489">not_use</strong></li><li id="EN-US_TOPIC_0000001231272825__li165141118112818"><strong id="EN-US_TOPIC_0000001231272825__b95275473366">bind_existing</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row751415182288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p195142184283">eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p14514418202811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1751441832810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p451491852818">EIP ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001231272825__table0514518112818"></a><a name="table0514518112818"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table0514518112818" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Tags</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row12515151819286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="EN-US_TOPIC_0000001231272825__p1951511813289"><strong id="EN-US_TOPIC_0000001231272825__b1511418511">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="EN-US_TOPIC_0000001231272825__p145152181288"><strong id="EN-US_TOPIC_0000001231272825__b658343024">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="EN-US_TOPIC_0000001231272825__p8515418122818"><strong id="EN-US_TOPIC_0000001231272825__b1118588873">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="EN-US_TOPIC_0000001231272825__p145152189287"><strong id="EN-US_TOPIC_0000001231272825__b1652013653">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row12515101818281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1751571842815">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1251691822817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1051611812287">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p1951601882815">Key. A tag key can contain a maximum of 128 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>
<tr id="EN-US_TOPIC_0000001231272825__row651601820287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001231272825__p135161818182820">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001231272825__p12516118202812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001231272825__p1851671810284">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001231272825__p5516171811288">Value. A tag value can contain a maximum of 255 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>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__section6284054162813"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table11275129182912" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row727610942912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001231272825__p1327619102910"><strong id="EN-US_TOPIC_0000001231272825__b1610107318208">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0000001231272825__p10276169162914"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b1722721919331">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0000001231272825__p8276799299"><strong id="EN-US_TOPIC_0000001231272825__b794141613">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row92761891295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001231272825__p227613962914">cluster</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001231272825__p13276129162914"><a href="#EN-US_TOPIC_0000001231272825__table427689172914">Cluster</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001231272825__p62761193291">Cluster object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001231272825__table427689172914"></a><a name="table427689172914"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__table427689172914" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Cluster</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row8277590290"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001231272825__p12779912916"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b13689125113314">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001231272825__p22778942910"><strong id="EN-US_TOPIC_0000001231272825__b188437012">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001231272825__p16277794294"><strong id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_b1899919276334">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row142771498299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001231272825__p14277149162915">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001231272825__p192781797298">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001231272825__p102789915298">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_s79d3edcb64b244b1bf0f33da4adab8d6"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_s4f043beafa2c47b1bf779a83498489ea">POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
{
"cluster": {
"node_type": "dws.m1.xlarge.ultrahigh",
"number_of_node": 3,
"subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
"security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
"vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
"availability_zone": "eu-de-01",
"port": 8000,
"name": "dws-1",
"user_name": "dbadmin",
"user_pwd": "Password!",
"public_ip": {
"public_bind_type": "auto_assign",
"eip_id": ""
},
"enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada" }
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_s14151e40166b47bd9bc6be63c13728d2"><h4 class="sectiontitle">Example Responses</h4><pre class="screen" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_sc9b55c83a8544aca9505c46cee96b181">{
"cluster": {
"id": "7d85f602-a948-4a30-afd4-e84f47471c15"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001098816618_sfffefcf1591c452c87cf83b0cf1ac573"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231272825__en-us_topic_0000001437698585_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001231272825__row1065115598137"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001231272825__p1265519596135">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001231272825__p065614599134"><strong id="EN-US_TOPIC_0000001231272825__b891268369">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231272825__row16652185951311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p16562599133">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p26571159191310">The cluster has been successfully created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row136525598133"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p10658145917133">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1965825910139">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row20653759201320"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p1965995981312">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p065920592137">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row1265395914132"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p196601159171313">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1666019590131">You do not have required permissions.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row106533592133"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p36613596133">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1566135915132">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231272825__row2654659131316"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001231272825__p17662159201311">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001231272825__p1866211594137">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Managing Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink