lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/css/api-ref/css_03_0019.html
Zheng, Xiu 3fa966049f css api 20240704 version 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2024-07-22 17:01:37 +00:00

612 lines
51 KiB
HTML
Raw Blame History

<a name="css_03_0019"></a><a name="css_03_0019"></a>
<h1 class="topictitle1">Creating a Cluster</h1>
<div id="body1504578045818"><div class="section" id="css_03_0019__section5535191365611"><h4 class="sectiontitle">Function</h4><p id="css_03_0019__p41143140568">This API is used to create a cluster.</p>
</div>
<div class="section" id="css_03_0019__section3535913135615"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0019__screen1712184173715">POST /v1.0/{project_id}/clusters</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table155351113195611" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0019__row311410148566"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0019__p1911411455617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0019__p811414147563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0019__p211416149565">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0019__p12114914175616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row011401445615"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0019__p13114114115610">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0019__p131141614105611">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0019__p211481414566">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0019__p8114151414568">Project ID. For details about how to obtain a project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0019__section3535201311569"><h4 class="sectiontitle">Request</h4><p id="css_03_0019__p7480241201320"><a href="#css_03_0019__table1839843619476">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="css_03_0019__table1839843619476"></a><a name="table1839843619476"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1839843619476" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0019__row144081836154714"><th align="left" class="cellrowborder" valign="top" width="18.545454545454547%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0019__p1440963624719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.515151515151516%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0019__p1141311365470">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.070707070707073%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0019__p13414193614478">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.86868686868687%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0019__p104181436174710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row16421936164713"><td class="cellrowborder" valign="top" width="18.545454545454547%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0019__p042443610476">cluster</p>
</td>
<td class="cellrowborder" valign="top" width="17.515151515151516%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0019__p1142863618470">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.070707070707073%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0019__p743111368475">Object</p>
</td>
<td class="cellrowborder" valign="top" width="49.86868686868687%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0019__p11434436174715">Cluster. For details about related parameters, see <a href="#css_03_0019__table1535613145617">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1535613145617"></a><a name="table1535613145617"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1535613145617" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="css_03_0019__b84235270618226">cluster</strong> field description</caption><thead align="left"><tr id="css_03_0019__row21141114115612"><th align="left" class="cellrowborder" valign="top" width="18.191919191919194%" id="mcps1.3.3.4.2.5.1.1"><p id="css_03_0019__p1411411416567">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.12121212121212%" id="mcps1.3.3.4.2.5.1.2"><p id="css_03_0019__p1311471415563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.212121212121211%" id="mcps1.3.3.4.2.5.1.3"><p id="css_03_0019__p511491418566">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.474747474747474%" id="mcps1.3.3.4.2.5.1.4"><p id="css_03_0019__p4114714155614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row101143141560"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p12114181411565">instance</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p12114131425613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p311441411563">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p4114171475610">Instance. For details about related parameters, see <a href="#css_03_0019__table1656713138562">Table 4</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row0288165613411"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p519571284210">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p58311839105916">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p1719515127429">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p18195201210421">Type of the data search engine. For details about related parameters, see <a href="#css_03_0019__table1121072510499">Table 7</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row1911451410564"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p311421412568">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p13114101410568">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p211416149564">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p101141514135615">Cluster name. It contains 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.</p>
</td>
</tr>
<tr id="css_03_0019__row163153654912"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p2316163499">instanceNum</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p1931606104919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p15316156154916">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p1131636164912">Number of clusters. The value range is 1 to 32.</p>
</td>
</tr>
<tr id="css_03_0019__row1028142714199"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p1282152711194">backupStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p0282102710194">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p9282727121913">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p118933178148">Automatic snapshot creation. This function is disabled by default. For details about related parameters, see <a href="#css_03_0019__table36611859102113">Table 8</a>.</p>
<div class="note" id="css_03_0019__note148074073717"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0019__p168096053712">The automatic snapshot creation policy is enabled only if this parameter is specified.</p>
</div></div>
</td>
</tr>
<tr id="css_03_0019__row1391892313405"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p8918132324017">diskEncryption</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p3918192334014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p1991832310403">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p1919523194019">Indicates whether disks are encrypted. For details about related parameters, see <a href="#css_03_0019__table18671184912468">Table 9</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row1532416411127"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p1834019412129">httpsEnable</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p1034024171218">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p13340174115126">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><div class="p" id="css_03_0019__p181551941101220">Indicates whether communication is encrypted on the cluster. Available values include <strong id="css_03_0019__b3595124913285">true</strong> and <strong id="css_03_0019__b1960114516289">false</strong>. By default, communication encryption is disabled. When <strong id="css_03_0019__b747316432204">httpsEnable</strong> is set to <strong id="css_03_0019__b94733432205">true</strong>, <strong id="css_03_0019__b1247404382011">authorityEnable</strong> must be set to <strong id="css_03_0019__b1147444332015">true</strong>.<ul id="css_03_0019__ul18452172619128"><li id="css_03_0019__li12452026101217"><strong id="css_03_0019__b12765135414203">true</strong>: communication is encrypted on the cluster.</li><li id="css_03_0019__li4452112661212"><strong id="css_03_0019__b740663482913">false</strong>: communication is not encrypted on the cluster.</li></ul>
</div>
</td>
</tr>
<tr id="css_03_0019__row15589103810285"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p18589938102815">authorityEnable</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p17589238152819">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p1758903882820">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p1158963813282">Indicates whether to enable authentication. Available values include <strong id="css_03_0019__b913174215211">true</strong> and <strong id="css_03_0019__b513104213526">false</strong>. Authentication is disabled by default. When authentication is enabled, <strong id="css_03_0019__b16837415125320">httpsEnable</strong> must be set to <strong id="css_03_0019__b1882215336539">true</strong>.</p>
<ul id="css_03_0019__ul9784127123119"><li id="css_03_0019__li11784927143117">Value <strong id="css_03_0019__b1793343865313">true</strong> indicates that authentication is enabled for the cluster.</li><li id="css_03_0019__li17848278311">Value <strong id="css_03_0019__b1943314205414">false</strong> indicates that authentication is disabled for the cluster.<div class="note" id="css_03_0019__note090721924713"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0019__p199092199474">This parameter is supported in clusters 7.1.1 or later.</p>
</div></div>
</li></ul>
</td>
</tr>
<tr id="css_03_0019__row179517454286"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p1879544582814">adminPwd</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p1279544592813">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p1779534542811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p12795545142811">Password of the cluster user <strong id="css_03_0019__b71042341549">admin</strong> in security mode. This parameter is mandatory only when <strong id="css_03_0019__b1993411459546">authorityEnable</strong> is set to <strong id="css_03_0019__b1337584815411">true</strong>.</p>
<div class="note" id="css_03_0019__note11416115011915"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="css_03_0019__ul17476111182019"><li id="css_03_0019__li48923811304">The administrator password must meet the following requirements:<ul id="css_03_0019__ul68851312133019"><li id="css_03_0019__li588591210303">The password can contain 8 to 32 characters.</li><li id="css_03_0019__li196769234308">Passwords must contain at least 3 of the following character types: uppercase letters, lowercase letters, numbers, and special characters (~!@#$%^&amp;*()-_=+\\|[{}];:,&lt;.&gt;/?).</li></ul>
</li><li id="css_03_0019__li179551538113020">Weak password verification is required for a security cluster. You are advised to set a strong password.</li></ul>
</div></div>
</td>
</tr>
<tr id="css_03_0019__row56330518236"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p463405162312">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p126346572316">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p16342522312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p963445112310">Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string <strong id="css_03_0019__b1595862585153754">0</strong> or in UUID format with hyphens (-). Value <strong id="css_03_0019__b2236161955011">0</strong> indicates the default enterprise project.</p>
<div class="note" id="css_03_0019__note15267102019118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0019__p7268152011118">For details about how to obtain enterprise project IDs and features, see the .</p>
</div></div>
</td>
</tr>
<tr id="css_03_0019__row1960119341096"><td class="cellrowborder" valign="top" width="18.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p166017341698">tags</p>
</td>
<td class="cellrowborder" valign="top" width="18.12121212121212%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0019__p13601203411918">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.212121212121211%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p106017348918">Array of <a href="#css_03_0019__table2059816589135">tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p160143410915">Tags in a cluster.</p>
<div class="note" id="css_03_0019__note1752134294510"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0019__p1617131017276">For details about the tag feature, see the Tag Management Service.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1656713138562"></a><a name="table1656713138562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1656713138562" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0019__b1365506179">instance</strong> field description</caption><thead align="left"><tr id="css_03_0019__row311410146564"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.5.2.5.1.1"><p id="css_03_0019__p13114121413566">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.5.2.5.1.2"><p id="css_03_0019__p6114161410569">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.3.5.2.5.1.3"><p id="css_03_0019__p12114171435615">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.42574257425742%" id="mcps1.3.3.5.2.5.1.4"><p id="css_03_0019__p11114314145619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row2114314115613"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.5.2.5.1.1 "><p id="css_03_0019__p111431445615">flavorRef</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.5.2.5.1.2 "><p id="css_03_0019__p1911421455618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.5.2.5.1.3 "><p id="css_03_0019__p11145146569">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p111145146568">Instance flavor name. For example:</p>
<ul id="css_03_0019__ul55698341357"><li id="css_03_0019__li17569193411351">Value range of flavor <strong id="css_03_0019__b189442057161016">css.medium.8</strong>: 40 GB to 640 GB</li><li id="css_03_0019__li94020713610">Value range of flavor <strong id="css_03_0019__b13664146141115">css.xlarge.8</strong>: 40 GB to 2,560 GB</li><li id="css_03_0019__li18974414183614">Value range of flavor <strong id="css_03_0019__b161219105114">css.2xlarge.8</strong>: 80 GB to 5,120 GB</li><li id="css_03_0019__li142731924153618">Value range of flavor <strong id="css_03_0019__b9809121419113">css.4xlarge.8</strong>: 160 GB to 10,240 GB</li><li id="css_03_0019__li16284629175915">Value range of flavor <strong id="css_03_0019__b1441717354400">css.xlarge.4</strong>: 40 GB to 1,600 GB</li><li id="css_03_0019__li202141140013">Value range of flavor <strong id="css_03_0019__b1375755310406">css.2xlarge.4</strong>: 80 GB to 3,200 GB</li><li id="css_03_0019__li18810173717018">Value range of flavor <strong id="css_03_0019__b989517112414">css.4xlarge.4</strong>: 100 GB to 6,400 GB</li><li id="css_03_0019__li366642215212">Value range of flavor <strong id="css_03_0019__b1861717292416">css.8xlarge.4</strong>: 160 GB to 10,240 GB</li><li id="css_03_0019__li15583644823">Value range of flavor <strong id="css_03_0019__b17256144174112">css.xlarge.2</strong>: 40 GB to 800 GB</li><li id="css_03_0019__li79212713317">Value range of flavor <strong id="css_03_0019__b1492412589415">css.2xlarge.2</strong>: 80 GB to 1,600 GB</li><li id="css_03_0019__li486653313314">Value range of flavor <strong id="css_03_0019__b8778616174220">css.4xlarge.2</strong>: 100 GB to 3,200 GB</li><li id="css_03_0019__li157682572038">Value range of flavor <strong id="css_03_0019__b8335124144212">css.8xlarge.2</strong>: 320 GB to 10,240 GB</li></ul>
</td>
</tr>
<tr id="css_03_0019__row1430531211619"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.5.2.5.1.1 "><p id="css_03_0019__p1764951813166">volume</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.5.2.5.1.2 "><p id="css_03_0019__p13649111831613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.5.2.5.1.3 "><p id="css_03_0019__p1164911188163">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p13650141891614">Information about the volume. For details about related parameters, see <a href="#css_03_0019__table11567131335613">Table 5</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row211481410562"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.5.2.5.1.1 "><p id="css_03_0019__p17114171445618">nics</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.5.2.5.1.2 "><p id="css_03_0019__p111144141567">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.5.2.5.1.3 "><p id="css_03_0019__p131146145562">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p19114171413565">Subnet information. For details about related parameters, see <a href="#css_03_0019__table1959831319562">Table 6</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row1471028164115"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.5.2.5.1.1 "><p id="css_03_0019__p1641339204112">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.5.2.5.1.2 "><p id="css_03_0019__p17641239194115">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.5.2.5.1.3 "><p id="css_03_0019__p5641339154116">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p184186269549">Availability zone (AZ). A single AZ is created when this parameter is not specified.</p>
<p id="css_03_0019__p27594571757">Separate multiple AZs with commas (,), for example, <strong id="css_03_0019__b105526475443">az1,az2</strong>. AZs must be unique and ensure that the number of nodes be at least the number of AZs.</p>
<p id="css_03_0019__p106211606349">If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ. If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table11567131335613"></a><a name="table11567131335613"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table11567131335613" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="css_03_0019__b1919334071">volume</strong> field description</caption><thead align="left"><tr id="css_03_0019__row4114101435619"><th align="left" class="cellrowborder" valign="top" width="15.559999999999999%" id="mcps1.3.3.6.2.5.1.1"><p id="css_03_0019__p1511401416567">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.3.6.2.5.1.2"><p id="css_03_0019__p311471413563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.32%" id="mcps1.3.3.6.2.5.1.3"><p id="css_03_0019__p16114151416564">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.68%" id="mcps1.3.3.6.2.5.1.4"><p id="css_03_0019__p411414143564">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row12114314195613"><td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.3.6.2.5.1.1 "><p id="css_03_0019__p1211414145563">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.6.2.5.1.2 "><p id="css_03_0019__p11114121465615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.32%" headers="mcps1.3.3.6.2.5.1.3 "><p id="css_03_0019__p41141114125611">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.68%" headers="mcps1.3.3.6.2.5.1.4 "><p id="css_03_0019__p20114171445614"><strong id="css_03_0019__b17991829111015">COMMON</strong>: Common I/O</p>
<p id="css_03_0019__p411471465616"><strong id="css_03_0019__b2911428131120">HIGH</strong>: High I/O</p>
<p id="css_03_0019__p1311431405610"><strong id="css_03_0019__b49772406111">ULTRAHIGH</strong>: Ultra-high I/O</p>
</td>
</tr>
<tr id="css_03_0019__row71141114145614"><td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.3.6.2.5.1.1 "><p id="css_03_0019__p1411401413563">size</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.6.2.5.1.2 "><p id="css_03_0019__p21147147566">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.32%" headers="mcps1.3.3.6.2.5.1.3 "><p id="css_03_0019__p71149143562">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.68%" headers="mcps1.3.3.6.2.5.1.4 "><p id="css_03_0019__p8114161418569">Volume size. The minimum value is 40. The value must be a multiple of 4 and 10.</p>
<p id="css_03_0019__p16320181203820">Unit: GB</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1959831319562"></a><a name="table1959831319562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1959831319562" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="css_03_0019__b171797216">nics</strong> field description</caption><thead align="left"><tr id="css_03_0019__row411461445618"><th align="left" class="cellrowborder" valign="top" width="15.049999999999999%" id="mcps1.3.3.7.2.5.1.1"><p id="css_03_0019__p9114101414569">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.45%" id="mcps1.3.3.7.2.5.1.2"><p id="css_03_0019__p011461445616">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.120000000000001%" id="mcps1.3.3.7.2.5.1.3"><p id="css_03_0019__p13114131415619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.379999999999995%" id="mcps1.3.3.7.2.5.1.4"><p id="css_03_0019__p911491435613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row96965570369"><td class="cellrowborder" valign="top" width="15.049999999999999%" headers="mcps1.3.3.7.2.5.1.1 "><p id="css_03_0019__p240011597368">vpcId</p>
</td>
<td class="cellrowborder" valign="top" width="15.45%" headers="mcps1.3.3.7.2.5.1.2 "><p id="css_03_0019__p54003593363">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.7.2.5.1.3 "><p id="css_03_0019__p3400165910366">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.379999999999995%" headers="mcps1.3.3.7.2.5.1.4 "><p id="css_03_0019__p7415135911368">VPC ID, which is used for configuring cluster network.</p>
</td>
</tr>
<tr id="css_03_0019__row311410149566"><td class="cellrowborder" valign="top" width="15.049999999999999%" headers="mcps1.3.3.7.2.5.1.1 "><p id="css_03_0019__p1114141419563">netId</p>
</td>
<td class="cellrowborder" valign="top" width="15.45%" headers="mcps1.3.3.7.2.5.1.2 "><p id="css_03_0019__p10114191411569">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.7.2.5.1.3 "><p id="css_03_0019__p16114214165616">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.379999999999995%" headers="mcps1.3.3.7.2.5.1.4 "><p id="css_03_0019__p4114101445616">Subnet ID. All instances in a cluster must have the same subnets and security groups.</p>
</td>
</tr>
<tr id="css_03_0019__row1114614195611"><td class="cellrowborder" valign="top" width="15.049999999999999%" headers="mcps1.3.3.7.2.5.1.1 "><p id="css_03_0019__p611471410563">securityGroupId</p>
</td>
<td class="cellrowborder" valign="top" width="15.45%" headers="mcps1.3.3.7.2.5.1.2 "><p id="css_03_0019__p611410141567">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.7.2.5.1.3 "><p id="css_03_0019__p7114181418567">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.379999999999995%" headers="mcps1.3.3.7.2.5.1.4 "><p id="css_03_0019__p3114914195618">Security group ID. All instances in a cluster must have the same subnets and security groups.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1121072510499"></a><a name="table1121072510499"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1121072510499" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="css_03_0019__b644076390">datastore</strong> field description</caption><thead align="left"><tr id="css_03_0019__row9210132514499"><th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.3.8.2.5.1.1"><p id="css_03_0019__p257003611426">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.659999999999998%" id="mcps1.3.3.8.2.5.1.2"><p id="css_03_0019__p1057073612420">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.32%" id="mcps1.3.3.8.2.5.1.3"><p id="css_03_0019__p1457083654210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.17%" id="mcps1.3.3.8.2.5.1.4"><p id="css_03_0019__p1757018361424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row1121052512495"><td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.8.2.5.1.1 "><p id="css_03_0019__p6570143664211">version</p>
</td>
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.3.8.2.5.1.2 "><p id="css_03_0019__p3570153613422">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.32%" headers="mcps1.3.3.8.2.5.1.3 "><p id="css_03_0019__p18570636184216">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.17%" headers="mcps1.3.3.8.2.5.1.4 "><p id="css_03_0019__p8570193615422">Engine version. For details about the supported versions, see <a href="css_03_0056.html">Supported Cluster Versions</a>.</p>
</td>
</tr>
<tr id="css_03_0019__row134267612250"><td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.8.2.5.1.1 "><p id="css_03_0019__p174261868256">type</p>
</td>
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.3.8.2.5.1.2 "><p id="css_03_0019__p34272615255">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.32%" headers="mcps1.3.3.8.2.5.1.3 "><p id="css_03_0019__p24274612517">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.17%" headers="mcps1.3.3.8.2.5.1.4 "><p id="css_03_0019__p194276622512">Engine type. Elasticsearch and OpenSearch are supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table36611859102113"></a><a name="table36611859102113"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table36611859102113" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="css_03_0019__b102715493565">backupStrategy</strong> field description</caption><thead align="left"><tr id="css_03_0019__row1866611598214"><th align="left" class="cellrowborder" valign="top" width="15.85%" id="mcps1.3.3.9.2.5.1.1"><p id="css_03_0019__p3670105915214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.3.9.2.5.1.2"><p id="css_03_0019__p96721159182113">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.590000000000002%" id="mcps1.3.3.9.2.5.1.3"><p id="css_03_0019__p1667485992116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.71000000000001%" id="mcps1.3.3.9.2.5.1.4"><p id="css_03_0019__p66771359162110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row76790597216"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p166821595210">period</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p17685175914214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p10686165912114">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p284353717266">Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <span class="parmname" id="css_03_0019__parmname207181910155010"><b>HH:mm z</b></span>. In the format, <span class="parmname" id="css_03_0019__parmname26580719510"><b>HH:mm</b></span> refers to the hour time and <span class="parmname" id="css_03_0019__parmname12640155145015"><b>z</b></span> refers to the time zone, for example, <span class="parmvalue" id="css_03_0019__parmvalue150123314505"><b>00:00 GMT+08:00</b></span> and <span class="parmvalue" id="css_03_0019__parmvalue4721153212417"><b>01:00 GMT+02:00</b></span>.</p>
</td>
</tr>
<tr id="css_03_0019__row66931659202111"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p0694195919216">prefix</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p26971859182110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p869955982113">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p9701195913219">Prefix of the name of the snapshot that is automatically created.</p>
</td>
</tr>
<tr id="css_03_0019__row14805002217"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p6481050152216">keepday</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p20481509225">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p18488504223">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p6489502223">Number of days for which automatically created snapshots are reserved.</p>
<p id="css_03_0019__p182811195615">Value range: 1 to 90</p>
</td>
</tr>
<tr id="css_03_0019__row9818174912172"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p837215054813">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p4441233891">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p186181046114912">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p9448924192218">OBS bucket used for storing backup. If there is snapshot data in an OBS bucket, only the OBS bucket will be used for backup storage and cannot be changed.</p>
</td>
</tr>
<tr id="css_03_0019__row5624145317178"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p1973364414814">basePath</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p1273354413481">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p1673316448484">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p1773364418486">Storage path of the snapshot in the OBS bucket.</p>
</td>
</tr>
<tr id="css_03_0019__row72721057151716"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p1343434015485">agency</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.9.2.5.1.2 "><p id="css_03_0019__p443424054812">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p1543414094815">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p194341340174817">IAM agency used to access OBS.</p>
<div class="note" id="css_03_0019__note187613118265"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_03_0019__p477133102618">If none of the <strong id="css_03_0019__b171075402528">bucket</strong>, <strong id="css_03_0019__b1065234685217">basePath</strong>, and <strong id="css_03_0019__b1290812483520">agency</strong> parameters are specified, the system will automatically create an OBS bucket and an IAM agency.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table18671184912468"></a><a name="table18671184912468"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table18671184912468" frame="border" border="1" rules="all"><caption><b>Table 9 </b><strong id="css_03_0019__b161491339125816">diskEncryption</strong> field description</caption><thead align="left"><tr id="css_03_0019__row14688114919464"><th align="left" class="cellrowborder" valign="top" width="16.94%" id="mcps1.3.3.10.2.5.1.1"><p id="css_03_0019__p76929493462">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.640000000000002%" id="mcps1.3.3.10.2.5.1.2"><p id="css_03_0019__p4695174911463">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.930000000000003%" id="mcps1.3.3.10.2.5.1.3"><p id="css_03_0019__p47005496467">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.49000000000001%" id="mcps1.3.3.10.2.5.1.4"><p id="css_03_0019__p167021949164619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row87056492467"><td class="cellrowborder" valign="top" width="16.94%" headers="mcps1.3.3.10.2.5.1.1 "><p id="css_03_0019__p8708114914466">systemEncrypted</p>
</td>
<td class="cellrowborder" valign="top" width="13.640000000000002%" headers="mcps1.3.3.10.2.5.1.2 "><p id="css_03_0019__p1871144924611">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.930000000000003%" headers="mcps1.3.3.10.2.5.1.3 "><p id="css_03_0019__p971424919464">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.49000000000001%" headers="mcps1.3.3.10.2.5.1.4 "><p id="css_03_0019__p1071724934610">Value <strong id="css_03_0019__b10809148152220">1</strong> indicates encryption is performed, and value <strong id="css_03_0019__b1041715111236">0</strong> indicates encryption is not performed.</p>
</td>
</tr>
<tr id="css_03_0019__row1872054954614"><td class="cellrowborder" valign="top" width="16.94%" headers="mcps1.3.3.10.2.5.1.1 "><p id="css_03_0019__p372314911466">systemCmkid</p>
</td>
<td class="cellrowborder" valign="top" width="13.640000000000002%" headers="mcps1.3.3.10.2.5.1.2 "><p id="css_03_0019__p772615498467">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.930000000000003%" headers="mcps1.3.3.10.2.5.1.3 "><p id="css_03_0019__p9727749184619">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.49000000000001%" headers="mcps1.3.3.10.2.5.1.4 "><p id="css_03_0019__p155270534461">Key ID.</p>
<ul id="css_03_0019__ul9357152215468"><li id="css_03_0019__li1325105810406">The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with <span class="parmvalue" id="css_03_0019__parmvalue2967115854615"><b>/default</b></span> in KMS to create clusters.</li><li id="css_03_0019__li19597184764115">After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table2059816589135"></a><a name="table2059816589135"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table2059816589135" frame="border" border="1" rules="all"><caption><b>Table 10 </b><strong id="css_03_0019__b76211985114">tags</strong> field description</caption><thead align="left"><tr id="css_03_0019__row26201158201311"><th align="left" class="cellrowborder" valign="top" width="16.35%" id="mcps1.3.3.11.2.5.1.1"><p id="css_03_0019__p86236581137">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.149999999999999%" id="mcps1.3.3.11.2.5.1.2"><p id="css_03_0019__p36296580135">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.23%" id="mcps1.3.3.11.2.5.1.3"><p id="css_03_0019__p76331158131314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.269999999999996%" id="mcps1.3.3.11.2.5.1.4"><p id="css_03_0019__p136334588136">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row5636658161319"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.11.2.5.1.1 "><p id="css_03_0019__p136381458101310">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.149999999999999%" headers="mcps1.3.3.11.2.5.1.2 "><p id="css_03_0019__p1264115812138">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.23%" headers="mcps1.3.3.11.2.5.1.3 "><p id="css_03_0019__p8643358111310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.3.11.2.5.1.4 "><p id="css_03_0019__p11100135652411">Tag key. The value can contain 1 to 36 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="css_03_0019__row3650125891311"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.11.2.5.1.1 "><p id="css_03_0019__p116549588131">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.149999999999999%" headers="mcps1.3.3.11.2.5.1.2 "><p id="css_03_0019__p86570583138">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.23%" headers="mcps1.3.3.11.2.5.1.3 "><p id="css_03_0019__p176601058121313">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.3.11.2.5.1.4 "><p id="css_03_0019__p412012517256">Tag value. The value can contain 0 to 43 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0019__section1261411310560"><h4 class="sectiontitle">Response</h4><p id="css_03_0019__p12641343181518"><a href="#css_03_0019__table1088918316183">Table 11</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="css_03_0019__table1088918316183"></a><a name="table1088918316183"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1088918316183" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter description</caption><thead align="left"><tr id="css_03_0019__row3889130189"><th align="left" class="cellrowborder" valign="top" width="24.5024502450245%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0019__p1214201516183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.872787278727873%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0019__p148892310183">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.624762476247625%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0019__p988917381817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row1889183201813"><td class="cellrowborder" valign="top" width="24.5024502450245%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0019__p8889931181">cluster</p>
</td>
<td class="cellrowborder" valign="top" width="27.872787278727873%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0019__p1388913181817">Object</p>
</td>
<td class="cellrowborder" valign="top" width="47.624762476247625%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0019__p3889123181818">Cluster. For details, see <a href="#css_03_0019__table2614813135615">Table 12</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table2614813135615"></a><a name="table2614813135615"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table2614813135615" frame="border" border="1" rules="all"><caption><b>Table 12 </b><strong id="css_03_0019__b1177258769">cluster</strong> field description</caption><thead align="left"><tr id="css_03_0019__row1611419143569"><th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0019__p10114141412569">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.782878287828783%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0019__p111141014195619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.804680468046804%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0019__p3114151415563">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row1511418148568"><td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0019__p1111451415613">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.782878287828783%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0019__p3114314145616">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.804680468046804%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0019__p4114171419566">Cluster ID.</p>
</td>
</tr>
<tr id="css_03_0019__row2114181411562"><td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0019__p511411418561">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.782878287828783%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0019__p1211411416562">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.804680468046804%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0019__p81141114125615">Cluster name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0019__section153121221152"><h4 class="sectiontitle">Examples</h4><p id="css_03_0019__p784715140399">Example request</p>
<pre class="screen" id="css_03_0019__screen17477277212">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters
{
"cluster": {
"name": "ES-Test",
"instanceNum": 4,
"instance": {
"availability_zone": "eu-du-01",
"flavorRef": "css.large.8",
"volume": {
"volume_type": "COMMON",
"size": 100
},
"nics": {
"vpcId": "fccd753c-91c3-40e2-852f-5ddf76d1a1b2",
"netId": "af1c65ae-c494-4e24-acd8-81d6b355c9f1",
"securityGroupId": "7e3fed21-1a44-4101-ab29-34e57124f614"
}
},
"httpsEnable": "false",
"diskEncryption": {
"systemEncrypted": "1",
"systemCmkid": "42546bb1-8025-4ad1-868f-600729c341ae"
}
}
}</pre>
<div class="p" id="css_03_0019__p6519133411167">Example response<pre class="screen" id="css_03_0019__screen4345181711110">{
"cluster": {
"id": "ef683016-871e-48bc-bf93-74a29d60d214",
"name": "ES-Test"
}
}</pre>
</div>
</div>
<div class="section" id="css_03_0019__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0019__p1147144641213"><a href="#css_03_0019__table209491933101317">Table 13</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0019__table209491933101317"></a><a name="table209491933101317"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table209491933101317" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Status code</caption><thead align="left"><tr id="css_03_0019__row194918333132"><th align="left" class="cellrowborder" valign="top" width="26.162616261626166%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0019__p6531343171310">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.522852285228524%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0019__p16534124318132">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.314531453145314%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0019__p1453710437131">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0019__row11949333171318"><td class="cellrowborder" valign="top" width="26.162616261626166%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0019__p1354264331315">400</p>
</td>
<td class="cellrowborder" valign="top" width="28.522852285228524%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0019__p175442043151310">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="45.314531453145314%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0019__p10547843141317">Invalid request.</p>
<p id="css_03_0019__p1954810435138">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0019__row15949153314139"><td class="cellrowborder" valign="top" width="26.162616261626166%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0019__p17551134391315">409</p>
</td>
<td class="cellrowborder" valign="top" width="28.522852285228524%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0019__p75541043121319">Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="45.314531453145314%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0019__p3555843131312">The request cannot be processed due to a conflict.</p>
<p id="css_03_0019__p75561143171311">This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.</p>
</td>
</tr>
<tr id="css_03_0019__row129491333137"><td class="cellrowborder" valign="top" width="26.162616261626166%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0019__p13559943141313">412</p>
</td>
<td class="cellrowborder" valign="top" width="28.522852285228524%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0019__p9562743101314">Precondition Failed</p>
</td>
<td class="cellrowborder" valign="top" width="45.314531453145314%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0019__p16565204314137">The server does not meet one of the preconditions that the requester puts on the request.</p>
</td>
</tr>
<tr id="css_03_0019__row09491533111315"><td class="cellrowborder" valign="top" width="26.162616261626166%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0019__p1656994351310">200</p>
</td>
<td class="cellrowborder" valign="top" width="28.522852285228524%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0019__p4573443111317">OK</p>
</td>
<td class="cellrowborder" valign="top" width="45.314531453145314%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0019__p1057744317139">The request is processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink