vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0020.html
Wang , Deng Ke daee48595f DDS API 20221101 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-10 07:51:13 +00:00

615 lines
46 KiB
HTML
Raw Blame History

<a name="dds_api_0020"></a><a name="dds_api_0020"></a>
<h1 class="topictitle1">Creating a DB Instance</h1>
<div id="body60002101"><div class="section" id="dds_api_0020__section4284989"><h4 class="sectiontitle">Function</h4><p id="dds_api_0020__p28332047">This API is used to create cluster, replica set instances.</p>
</div>
<div class="section" id="dds_api_0020__section38564907"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0020__ul13194498"><li id="dds_api_0020__li51641620">URI format<p id="dds_api_0020__p112110202496"><a name="dds_api_0020__li51641620"></a><a name="li51641620"></a>POST /v3/{project_id}/instances</p>
</li><li id="dds_api_0020__li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0020__row46529701"><th align="left" class="cellrowborder" valign="top" width="20.74%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0020__p10809459"><strong id="dds_api_0020__b842352706102328_1">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.810000000000002%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0020__p3150961"><strong id="dds_api_0020__b842352706102346_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.449999999999996%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0020__p2775334615440"><strong id="dds_api_0020__b2889154219311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row3925534"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0020__p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.810000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0020__p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.449999999999996%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0020__p43776822">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0020__section11539844"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0020__ul36592919"><li id="dds_api_0020__li60900816">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0020__row61525259"><th align="left" class="cellrowborder" valign="top" width="29.520000000000003%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_0020__p17490046"><strong id="dds_api_0020__b842352706102328_7">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_0020__p7407659"><strong id="dds_api_0020__b842352706102346_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.060000000000002%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_0020__p63149496"><strong id="dds_api_0020__b842352706164541_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_0020__p829918354016"><strong id="dds_api_0020__b452214511319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row60827539"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p28083633">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p60181840">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p42890904">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p51611184">Specifies the DB instance name. The DB instance name of the same DB engine is unique for the same tenant.</p>
<p id="dds_api_0020__p61847473">The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="dds_api_0020__row56760689"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p34213098">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p19797588">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p585814343514">Object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p58520811">Specifies the database information. For more information, see <a href="#dds_api_0020__table228903751753">Table 3</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row16540805"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p64736823">region</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p9191297">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p6297612">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p40344576">Specifies the region ID.</p>
<p id="dds_api_0020__p3825082612023">The value cannot be empty. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row9307971"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p15748167">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p533144">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p43184669">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p122956256251">Specifies the AZ ID.</p>
<p id="dds_api_0020__p49296060141410">The value cannot be empty. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row51313205"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p62728917">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p47877526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p52874399">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p54967961">Specifies the VPC ID. For details about how to obtain this parameter value, see section "Virtual Private Cloud" in the <em id="dds_api_0020__i842352697165629_1">Virtual Private Cloud API Reference</em>.</p>
<p id="dds_api_0020__p23219884">The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.</p>
</td>
</tr>
<tr id="dds_api_0020__row15861880"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p9743886">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p51057338">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p13242114155510">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p19042013">Specifies the subnet ID. For details about how to obtain this parameter value, see section "Subnet" in the <em id="dds_api_0020__i842352697165629_3">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="dds_api_0020__row66008059"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p1376611710555">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p25376232">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p2098817965512">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p34431157">Specifies the ID of the security group where a specified DB instance belongs to.</p>
<p id="dds_api_0020__p41444960">For details about how to obtain this parameter value, see section "Security Group" in the <em id="dds_api_0020__i842352697165629_5">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="dds_api_0020__row159113725612"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p164189456567">password</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p34185452568">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p1041814515560">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p14418145185610">Specifies the database password.</p>
<p id="dds_api_0020__p26487069">The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?</p>
<p id="dds_api_0020__p12429628144458">You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking.</p>
</td>
</tr>
<tr id="dds_api_0020__row166071201577"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p16918122175716">disk_encryption_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p39184275719">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p09181214570">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p091822175717">Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. </p>
<p id="dds_api_0020__p59182025571">If this parameter is not transferred, disk encryption is not performed.</p>
</td>
</tr>
<tr id="dds_api_0020__row33762549"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p7287161811578">mode</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p72872184576">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p132871018165719">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p142871818175710">Specifies the instance type. Cluster, replica set instances are supported.</p>
<p id="dds_api_0020__p1228716183574">Valid value:</p>
<ul id="dds_api_0020__ul358318483493"><li id="dds_api_0020__li458314484490">Sharding</li><li id="dds_api_0020__li105831848134919">ReplicaSet</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row48829755"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p11644203014577">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p2644230135711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p57556557376">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p15644130115717">Specifies the instance specifications. For more information, see <a href="#dds_api_0020__table94791241013">Table 4</a>.</p>
<p id="dds_api_0020__p5644133025714">For details about how to obtain the value, see the response values of <strong id="dds_api_0020__b1738412109577">flavor</strong> in <a href="dds_instance_specification.html">Querying All DB Instance Specifications</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row1289615471281"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p2758135918812">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p97671759782">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p1350774773916">Object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p1793175919811">Specifies the advanced backup policy. For more information, see <a href="#dds_api_0020__table15990419397">Table 5</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row1845081915611"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p6451121945610">ssl_option</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p3451519135619">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p04511719105619">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p145112192562">Specifies whether to enable SSL.</p>
<p id="dds_api_0020__p219653874515">Valid value:</p>
<ul id="dds_api_0020__ul89411619185711"><li id="dds_api_0020__li693623319579">The value <strong id="dds_api_0020__b10969162115517">0</strong> indicates that SSL is disabled by default.</li><li id="dds_api_0020__li1966416017584">The value <strong id="dds_api_0020__b1140510221551">1</strong> indicates that SSL is enabled by default.</li><li id="dds_api_0020__li9941819125719">If this parameter is not transferred, SSL is enabled by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table228903751753"></a><a name="table228903751753"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table228903751753" frame="border" border="1" rules="all"><caption><b>Table 3 </b>datastore field data structure description</caption><thead align="left"><tr id="dds_api_0020__row70524471753"><th align="left" class="cellrowborder" valign="top" width="29.330000000000002%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dds_api_0020__p343772981753"><strong id="dds_api_0020__b842352706102328_9">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.6%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dds_api_0020__p330977911753"><strong id="dds_api_0020__b842352706102346_7">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.07%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dds_api_0020__p636754041753"><strong id="dds_api_0020__b842352706164541_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dds_api_0020__p574120414014"><strong id="dds_api_0020__b348844611312">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row216489991753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0020__p1521482415580">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0020__p42146248583">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p13214192410581">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p10214162414580"></p>
<p id="dds_api_0020__p5562520192718">Specifies the database type. DDS Community Edition is supported. The value is <strong id="dds_api_0020__b22814210211">DDS-Community</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row363844211753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0020__p42144246586">version</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0020__p162141624165815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p112141824105817"></p>
<p id="dds_api_0020__p720354992810">Specifies the database version. The value is <strong id="dds_api_0020__b094560173417">3.2</strong> or <strong id="dds_api_0020__b299431325017">3.4</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row260045131753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0020__p152141624175815">storage_engine</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0020__p102145249581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p1072024123815">Specifies the storage engine. Currently, DDS supports the WiredTiger storage engine. The value is <strong id="dds_api_0020__b13522163233219">wiredTiger</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table94791241013"></a><a name="table94791241013"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table94791241013" frame="border" border="1" rules="all"><caption><b>Table 4 </b>flavor field data structure description</caption><thead align="left"><tr id="dds_api_0020__row14800249118"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="dds_api_0020__p1662124515111"><strong id="dds_api_0020__b430235112379">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="dds_api_0020__p11670144519110"><strong id="dds_api_0020__b900911122">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="dds_api_0020__p15675134514110"><strong id="dds_api_0020__b1469192918">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="dds_api_0020__p203621746403"><strong id="dds_api_0020__b19951343164218">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row2480924512"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dds_api_0020__p18116152911">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dds_api_0020__p11161852317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p121164521715">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p21161452619">Specifies the node type.</p>
<p id="dds_api_0020__p369141413331">Valid value:</p>
<ul id="dds_api_0020__ul121232613404"><li id="dds_api_0020__li161211263409">For a cluster instance, the value can be <strong id="dds_api_0020__b10928484446">mongos</strong>, <strong id="dds_api_0020__b15983455144410">shard</strong>, or <strong id="dds_api_0020__b14732155814414">config</strong>.</li><li id="dds_api_0020__li6121726104019">For a replica set instance, the value is <strong id="dds_api_0020__b1496317331458">replica</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row194801524017"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dds_api_0020__p17946205216">num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dds_api_0020__p179461801727">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p1994615016215">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p11946207210">Specifies node quantity.</p>
<p id="dds_api_0020__p1946140122">Valid value:</p>
<ul id="dds_api_0020__ul16946160926"><li id="dds_api_0020__li1772413451773">mongos: The value ranges from 2 to 16.</li><li id="dds_api_0020__li331361281">shard: The value ranges from 2 to 16.</li><li id="dds_api_0020__li119471301229">config: The value is <strong id="dds_api_0020__b1318012185488">1</strong>.</li><li id="dds_api_0020__li129471904215">replica: The value is <strong id="dds_api_0020__b1833473110367">1</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row5161165517286"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dds_api_0020__p131613551280">storage</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dds_api_0020__p1532310162817">This parameter is optional for all nodes except mongos. This parameter is invalid for the mongos nodes.</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p3589184744118">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p2887384610">Specifies the disk type.</p>
<p id="dds_api_0020__p15929549113710">Valid value: ULTRAHIGH, which indicates the type SSD.</p>
<p id="dds_api_0020__p1514452675914">This parameter is valid for the shard and config nodes of a community edition cluster instance, replica set instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.</p>
</td>
</tr>
<tr id="dds_api_0020__row84801524316"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dds_api_0020__p12619121114318">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dds_api_0020__p1615821120194">This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p661913115318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p13619151112319">Specifies the disk size.</p>
<p id="dds_api_0020__p16619211039">The value must be a multiple of 10. The unit is GB.</p>
<ul id="dds_api_0020__ul116195116311"><li id="dds_api_0020__li12431338142919">For a cluster instance, the storage space of a shard node can be 10 to 1000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.</li><li id="dds_api_0020__li961910111139">For a replica set instance, the value ranges from 10 to 2000.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row13588338389"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dds_api_0020__p1877334110385">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dds_api_0020__p77801941143817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p13788124173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p2079864173819">Specifies the resource specification code. For details about how to obtain the value, see the response values of <strong id="dds_api_0020__b15409175112507">spec_code</strong> in <a href="dds_instance_specification.html">Querying All DB Instance Specifications</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table15990419397"></a><a name="table15990419397"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table15990419397" frame="border" border="1" rules="all"><caption><b>Table 5 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="dds_api_0020__row13463201495"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.4.2.5.1.1"><p id="dds_api_0020__p258122019911"><strong id="dds_api_0020__b3515421175117">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.4.2.5.1.2"><p id="dds_api_0020__p47172016918"><strong id="dds_api_0020__b101106912">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="dds_api_0020__p19887204920"><strong id="dds_api_0020__b718548923">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="dds_api_0020__p542012552010"><strong id="dds_api_0020__b87114521838">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row12114172014914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="dds_api_0020__p1912612020911">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="dds_api_0020__p81383201395">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="dds_api_0020__p13150162018916">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="dds_api_0020__p8983181183415">Specifies the backup time window. Automated backups will be triggered during the backup time window.</p>
<p id="dds_api_0020__p144363282818">The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.</p>
<ul id="dds_api_0020__ul73551635192814"><li id="dds_api_0020__li13765154012810">The <strong id="dds_api_0020__b8466258394">HH</strong> value must be 1 greater than the <strong id="dds_api_0020__b174669581595">hh</strong> value.</li><li id="dds_api_0020__li1510111915298">The values of <strong id="dds_api_0020__b13214152101015">mm</strong> and <strong id="dds_api_0020__b321610214106">MM</strong> must be the same and must be set to any of the following: <strong id="dds_api_0020__b1421618251018">00</strong>, <strong id="dds_api_0020__b1521612261016">15</strong>, <strong id="dds_api_0020__b72161127109">30</strong>, or <strong id="dds_api_0020__b15217102201017">45</strong>.</li></ul>
<p id="dds_api_0020__p59342194324">Example value:</p>
<ul id="dds_api_0020__ul1210322243217"><li id="dds_api_0020__li17296724143217">08:15-09:15</li><li id="dds_api_0020__li18103722163216">23:00-00:00</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row111950203915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="dds_api_0020__p10206620196">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="dds_api_0020__p421932012920">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="dds_api_0020__p111662049164812">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="dds_api_0020__p19255132017913">Specifies the number of days to retain the generated backup files.</p>
<p id="dds_api_0020__p1627115206911">The value range is from 0 to 732.</p>
<ul id="dds_api_0020__ul20536122725718"><li id="dds_api_0020__li10536027165717">If this parameter is set to <strong id="dds_api_0020__b842352706112318">0</strong>, the automated backup policy is not set.</li><li id="dds_api_0020__li165366279571">If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for seven days by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="note" id="dds_api_0020__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0020__p4494936511312">The values of <strong id="dds_api_0020__b1722141165414">region</strong> and <strong id="dds_api_0020__b107233414541">availability_zone</strong> are used as examples.</p>
</div></div>
<ul id="dds_api_0020__ul10190321"><li id="dds_api_0020__li1036654112258">Request header<pre class="codeblock" id="dds_api_0020__codeblock1497683019423"><strong id="dds_api_0020__b143471965516">POST https://<em id="dds_api_0020__i034518945514">DDS</em><em id="dds_api_0020__i1534629205519"> endpoint</em>/v3/{<em id="dds_api_0020__i93471596553">project_id</em>}/instances</strong>.</pre>
</li><li id="dds_api_0020__li24604028">Example request<div class="p" id="dds_api_0020__p20109663"><a name="dds_api_0020__li24604028"></a><a name="li24604028"></a>Create a cluster instance.<pre class="codeblock" id="dds_api_0020__codeblock3265333317938">{
"name": "test-cluster-01",
"datastore": {
"type": "DDS-Community",
"version": "3.4",
"storage_engine": "wiredTiger"
},
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"password": "Test@123",
"mode": "Sharding",
"flavor": [
{
"type": "mongos",
"num": 2,
"spec_code": "dds.mongodb.s2.medium.4.mongos"
},
{
"type": "shard",
"num": 2,
"storage": "ULTRAHIGH",
"size": 20,
"spec_code": "dds.mongodb.s2.medium.4.shard"
},
{
"type": "config",
"num": 1,
"storage": "ULTRAHIGH",
"size": 20,
"spec_code": "dds.mongodb.s2.large.2.config"
}
],
"backup_strategy": {
"start_time": "08:15-09:15",
"keep_days": "8"
},
"ssl_option":"1"
}</pre>
</div>
<div class="p" id="dds_api_0020__p107111101979">Create a replica set instance.<pre class="codeblock" id="dds_api_0020__codeblock22965072171041">{
"name": "test-replicaset",
"datastore": {
"type": "DDS-Community",
"version": "3.4",
"storage_engine": "wiredTiger"
},
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"password": "Test@123",
"mode": "ReplicaSet",
"flavor": [
{
"type": "replica",
"num": 1,
"storage": "ULTRAHIGH",
"size": 30,
"spec_code": "dds.mongodb.s2.medium.4.repset"
}
],
"backup_strategy": {
"start_time": "08:15-09:15",
"keep_days": "8"
},
"ssl_option":"1"
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0020__section36749739"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0020__ul48268995"><li id="dds_api_0020__li31767774">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table27245651" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0020__row47625437"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0020__p32455223"><strong id="dds_api_0020__b842352706102328_25">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0020__p11627434"><strong id="dds_api_0020__b842352706164541_21">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0020__p152381041511"><strong id="dds_api_0020__b46627531333">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row51926520"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p45298596">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p45307656">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p46041549">Indicates the DB instance ID.</p>
</td>
</tr>
<tr id="dds_api_0020__row20114173217101"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p942262101114">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p1543113251117">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p15439202191111">Same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row1187910274115"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p891540131119">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p323001118407">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p33020407110">Indicates the database information, which is the same as the request parameter. For more information, see <a href="#dds_api_0020__table228903751753">Table 3</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row59793748"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1770211716105">created</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p1870215741016">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p157021731012">Indicates the creation time in the following format: yyyy-mm-dd hh:mm:ss.</p>
</td>
</tr>
<tr id="dds_api_0020__row591219314127"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p16849171341212">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p138561913181214">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p15866113151219">Indicates the DB instance status. The value is <span class="parmvalue" id="dds_api_0020__parmvalue5337746114210"><b>creating</b></span>.</p>
</td>
</tr>
<tr id="dds_api_0020__row32924936175949"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1535621031120">region</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p3356151013114">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p159871637193619">Indicates the region ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row11097898"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1535618104112">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p235661031119">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p2356181081116">Indicates the AZ ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row785288110273"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p135661012113">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p53561210161117">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p2356201012113">Indicates the VPC ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row6771693"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p12356161015111">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p73561910111114">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p6356111081115">Indicates the subnet ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row49289224"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1435661071112">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p113568101117">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p8356910131112">Indicates the ID of the security group to which the instance belongs, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row118272047171218"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p19867514132">disk_encryption_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p78782010132">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p68850151312">Indicates the ID of the disk encryption key, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row9414870143634"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p393916271115">mode</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p293912771120">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p1193910279117">Indicates the instance type, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row40529449"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1871214715112">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p824425424013">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p18491173333816">Indicates the instance specification, which is the same as the request parameter. For more information, see <a href="#dds_api_0020__table94791241013">Table 4</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row430511298132"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p848854719136">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p7935239134111">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p4509154751315">Indicates the advanced backup policy, which is the same as the request parameter. For more information, see <a href="#dds_api_0020__table15990419397">Table 5</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row109701120706"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p497012201508">ssl_option</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p10970132010013">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p74671737135118">Indicates whether to enable SSL, which functions the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row2353067711815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p16141310121213">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p1714161011120">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p10141141019125">Indicates the ID of the workflow for creating a DB instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="note" id="dds_api_0020__note58305880113644"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0020__p54990880113644">The values of <strong id="dds_api_0020__b135427152091">region</strong> and <strong id="dds_api_0020__b15542215594">availability_zone</strong> are used as examples.</p>
</div></div>
<ul id="dds_api_0020__ul50009058"><li id="dds_api_0020__li47428342">Response example<div class="p" id="dds_api_0020__p18497442191316"><a name="dds_api_0020__li47428342"></a><a name="li47428342"></a>Cluster instance:<pre class="codeblock" id="dds_api_0020__codeblock19377062171138">{
"id": "39b6a1a278844ac48119d86512e0000bin02",
"name": "test-cluster-01",
"datastore": {
"type": "DDS-Community",
"version": "3.4",
"storage_engine": "wiredTiger"
},
"created": "2019-01-16 09:34:36",
"status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "",
"mode": "Sharding",
"flavor": [
{
"type": "mongos",
"num": 2,
"spec_code": "dds.mongodb.s2.medium.4.mongos"
},
{
"type": "shard",
"num": 2,
"spec_code": "dds.mongodb.s2.medium.4.shard",
"size": 20
},
{
"type": "config",
"num": 1,
"spec_code": "dds.mongodb.s2.large.2.config",
"size": 20
}
],
"backup_strategy": {
"start_time": "08:15-09:15",
"keep_days": "8"
},
"ssl_option":"1",
"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"
}</pre>
</div>
<div class="p" id="dds_api_0020__p39712051151517">Replica set instance:<pre class="codeblock" id="dds_api_0020__codeblock5637539517131">{
"id": "46dfadfd2b674585a430217f23606cd7in02",
"name": "test-replicaset",
"datastore": {
"type": "DDS-Community",
"version": "3.4",
"storage_engine": "wiredTiger"
},
"created": "2019-01-16 09:33:08",
"status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "",
"mode": "ReplicaSet",
"flavor": [
{
"type": "replica",
"num": 1,
"spec_code": "dds.mongodb.s2.medium.4.repset",
"size": 30
}
],
"backup_strategy": {
"start_time": "08:15-09:15",
"keep_days": "7"
},
"ssl_option":"1",
"job_id": "2408417d-fd4b-40ae-bec6-e09ce594eb5f"
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0020__section5382712154838"><h4 class="sectiontitle"><strong id="dds_api_0020__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_api_0020__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0020__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0020__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink