youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0020.html
Ru, Li Yi a6e39ff5b3 DDS_API 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-05-27 08:52:30 +00:00

1024 lines
77 KiB
HTML
Raw Permalink 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, and single node 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 https://{Endpoint}/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="21%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0020__p10809459">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0020__p3150961">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0020__p2775334615440">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row3925534"><td class="cellrowborder" valign="top" width="21%" 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.999999999999996%" 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%" 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="21.21212121212121%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_0020__p17490046">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_0020__p7407659">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_0020__p63149496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.42424242424242%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_0020__p829918354016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row60827539"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p51611184">Specifies the DB instance name. Instance name, which can be the same as an existing name.</p>
<ul id="dds_api_0020__ul1444173811511"><li id="dds_api_0020__li9441138195114">The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row56760689"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" 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="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" 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="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p1791016812185">Specifies the AZ ID. You can select multiple AZs to create a cross-AZ cluster based on <strong id="dds_api_0020__b4518172142012">az_status</strong> returned by the API described in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</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="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p1593595153419">Specifies the VPC ID. To obtain this parameter value, use either of the following methods:</p>
<ul id="dds_api_0020__ul250415512347"><li id="dds_api_0020__li67651171359">Method 1: Log in to VPC console and view the VPC ID on the VPC details page.</li><li id="dds_api_0020__li948317405377">Method 2: See the "Querying VPCs" section in the <em id="dds_api_0020__i1202182675711">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row15861880"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p512371711393">Specifies the network ID of the subnet. To obtain this parameter value, use either of the following methods:</p>
<ul id="dds_api_0020__ul9152102763919"><li id="dds_api_0020__li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="dds_api_0020__b8564164510571">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="dds_api_0020__li14903124220396">Method 2: See the "Querying Subnets" section in the <em id="dds_api_0020__i733265018584">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row66008059"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p193681417164213">Specifies the security group ID. To obtain the security group ID, perform either of the following methods:</p>
<ul id="dds_api_0020__ul16404122194211"><li id="dds_api_0020__li94054222421">Method 1: Log in to VPC console. Choose <strong id="dds_api_0020__b225035017019">Access Control</strong> &gt; <strong id="dds_api_0020__b625015010015">Security Groups</strong> in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.</li><li id="dds_api_0020__li17405132214423">Method 2: See the "Querying Security Groups" section in the <em id="dds_api_0020__i1496515813515">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row725710104216"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p1625714117427">port</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p625815154216">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p102581714425">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p142581912425">Database access port</p>
<p id="dds_api_0020__p38646398423">Value range: 2100-9500, 27017, 27018, and 27019.</p>
<p id="dds_api_0020__p617033924319">If this parameter is not transferred, the port of the created DB instance is 8635 by default.</p>
</td>
</tr>
<tr id="dds_api_0020__row159113725612"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p34185452568">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p1461814285516">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">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="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p091822175717">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="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p142871818175710">Specifies the instance type. Cluster, replica set, and single node 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><li id="dds_api_0020__li19583124854918">Single</li></ul>
</td>
</tr>
<tr id="dds_api_0020__row48829755"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" 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 Database Specifications</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row1289615471281"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" 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__row18468239164312"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p163521844104312">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p114711139154319">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p10471103974311">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p62097554117">Specifies the enterprise project ID.</p>
<ul id="dds_api_0020__ul177751030726"><li id="dds_api_0020__li77759301023">This parameter is not transferred for users who have not enabled the enterprise multi-project service.</li><li id="dds_api_0020__li10775143015220">If this parameter is not transferred for a user who has enabled the enterprise multi-project service, the value is the default enterprise project.</li></ul>
<p id="dds_api_0020__p427334213013">To obtain the enterprise project ID, see the <strong id="dds_api_0020__b1859251742817">id</strong> value in the <span class="parmname" id="dds_api_0020__parmname2073619533913"><b>enterprise_project field data structure</b></span> table in section "Querying the Enterprise Project List" of the <em id="dds_api_0020__i38631236112710">Enterprise Management API Reference</em>.</p>
</td>
</tr>
<tr id="dds_api_0020__row1845081915611"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p145112192562">Specifies whether to enable or disable 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>
<tr id="dds_api_0020__row8177653152815"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0020__p5227116192919">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0020__p192273642918">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0020__p02276652916">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0020__p228311153117">Tag list</p>
<p id="dds_api_0020__p822726162911">A maximum of 20 tags can be added for each instance. For details, see <a href="#dds_api_0020__table1030225523118">Table 6</a>.</p>
</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="21.21212121212121%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dds_api_0020__p343772981753">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dds_api_0020__p330977911753">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dds_api_0020__p636754041753">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.42424242424242%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dds_api_0020__p574120414014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row216489991753"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p5562520192718">Specifies the database type. The value is <strong id="dds_api_0020__b954102218238">DDS-Community</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row363844211753"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0020__b638841714576">3.4</strong> or <strong id="dds_api_0020__b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" 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="19.191919191919194%" 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="17.171717171717173%" 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="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__ul915212153019"><li id="dds_api_0020__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__b175816920818">wiredTiger</strong>.</li></ul>
</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">Name</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">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="dds_api_0020__p15675134514110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="dds_api_0020__p203621746403">Description</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="17%" 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="42%" 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><li id="dds_api_0020__li412426134016">For a single node instance, the value is <strong id="dds_api_0020__b19013368452">single</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="17%" 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="42%" 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__li11589861">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0020__li85836115710">mongos: The value ranges from 2 to 32.</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 number of nodes can be 3, 5, or 7.</li><li id="dds_api_0020__li18947201121">single: The value is <strong id="dds_api_0020__b13456642203610">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__p616353417350">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" 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="42%" 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 cluster instance, replica set instances, and single node 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__p45501224145815">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dds_api_0020__p661913115318">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" 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__p15677154212581">This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.</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 2000 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><li id="dds_api_0020__li1061913111837">For a single node instance, the value ranges from 10 to 1000.</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="17%" 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="42%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dds_api_0020__p1798051252915">Specifies the resource specification code. For details about how to obtain the value, see the response values of <strong id="dds_api_0020__b382751042416">spec_code</strong> in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
<p id="dds_api_0020__p17827125193419">In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).</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__b842352706102346_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="dds_api_0020__p19887204920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="dds_api_0020__p542012552010">Description</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="18%" 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="41%" 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 <strong id="dds_api_0020__b1421618251018">00</strong>.</li><li id="dds_api_0020__li6314191214591">If this parameter is not transferred, the default backup time window is set to <strong id="dds_api_0020__b46791923938">00:00-01:00</strong>.</li></ul>
<p id="dds_api_0020__p59342194324">Example value:</p>
<p id="dds_api_0020__p1520917507251">23:00-00:00</p>
</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="18%" 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="41%" 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>
<div class="tablenoborder"><a name="dds_api_0020__table1030225523118"></a><a name="table1030225523118"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table1030225523118" frame="border" border="1" rules="all"><caption><b>Table 6 </b>tags field data structure description</caption><thead align="left"><tr id="dds_api_0020__row1830265543113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.5.2.5.1.1"><p id="dds_api_0020__p1130225511315">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.5.2.5.1.2"><p id="dds_api_0020__p430295516313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.5.2.5.1.3"><p id="dds_api_0020__p830235563115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.3.2.1.5.2.5.1.4"><p id="dds_api_0020__p1030255513119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row11302185503113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="dds_api_0020__p18491328347">key</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="dds_api_0020__p849142123413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="dds_api_0020__p1349115253411">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><p id="dds_api_0020__p12491723341">Tag key. The value can contain a maximum of 36 unicode characters.</p>
<p id="dds_api_0020__p2668123173416">The key cannot be left blank or an empty string.</p>
<p id="dds_api_0020__p14912213412">The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
</td>
</tr>
<tr id="dds_api_0020__row03030556312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="dds_api_0020__p13491112183416">value</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="dds_api_0020__p1849118213414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="dds_api_0020__p24916219348">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><p id="dds_api_0020__p1258913463419">Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string.</p>
<p id="dds_api_0020__p4491152173417">The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
</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__li24604028">Example request<p id="dds_api_0020__p1540072375312"><a name="dds_api_0020__li24604028"></a><a name="li24604028"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances</p>
<div class="p" id="dds_api_0020__p1280312155319">Create a cluster instance:<pre class="codeblock" id="dds_api_0020__codeblock38021821145319">{
"name": "test-cluster-01",
"datastore": {
"type": "DDS-Community",
"version": "4.0",
"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": "******",
"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": "23:00-00:00",
"keep_days": "8"
},
"ssl_option":"1",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}
Create a cluster instance:
{
"name": "test-cluster-01",
"datastore": {
"type": "DDS-Community",
"version": "4.0",
"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",
"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"
}
]
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</pre>
</div>
<div class="p" id="dds_api_0020__p11806102114531">Create a replica set instance.<pre class="codeblock" id="dds_api_0020__codeblock580522145315">{
"name": "test-replicaset",
"datastore": {
"type": "DDS-Community",
"version": "4.0",
"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": "******",
"mode": "ReplicaSet",
"flavor": [
{
"type": "replica",
"num": 1,
"storage": "ULTRAHIGH",
"size": "30",
"spec_code": "dds.mongodb.s2.medium.4.repset"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "8"
},
"ssl_option":"1",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</pre>
</div>
<div class="p" id="dds_api_0020__p580792155312">Create a single node instance.<pre class="codeblock" id="dds_api_0020__codeblock17807132119533">{
"name": "test-singlenode",
"datastore": {
"type": "DDS-Community",
"version": "4.0",
"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": "******",
"mode": "Single",
"flavor": [
{
"type": "single",
"num": 1,
"storage": "ULTRAHIGH",
"size": "30",
"spec_code": "dds.mongodb.s2.medium.4.single"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "8"
},
"ssl_option":"1",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</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 7 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0020__row47625437"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0020__p32455223">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0020__p11627434">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0020__p152381041511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__row51926520"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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__table149461548134">Table 8</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row59793748"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p6356111081115">Indicates the network ID of the subnet, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row49289224"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p8356910131112">Indicates the security group ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0020__row11907145354414"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1990765394413">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p3907145344416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p990705315440">Indicates the database port.</p>
</td>
</tr>
<tr id="dds_api_0020__row118272047171218"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p17815151161414">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="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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__table119482048538">Table 9</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row430511298132"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" 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__table59521648930">Table 10</a>.</p>
</td>
</tr>
<tr id="dds_api_0020__row1914025175818"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1114216516587">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p151429516589">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p21423513584">Indicates the enterprise project ID. If the value is <strong id="dds_api_0020__b203671231504">0</strong>, the resource belongs to the default enterprise project.</p>
</td>
</tr>
<tr id="dds_api_0020__row109701120706"><td class="cellrowborder" valign="top" width="22%" 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="20%" 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="57.99999999999999%" 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="22%" 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="20%" 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="57.99999999999999%" 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>
<tr id="dds_api_0020__row99330073616"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0020__p1994310333618">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0020__p49431393618">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0020__p4943537366">Tag list, which is the same as the request parameter.</p>
<p id="dds_api_0020__p165788543710">For details, see <a href="#dds_api_0020__table1695414482318">Table 11</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table149461548134"></a><a name="table149461548134"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table149461548134" frame="border" border="1" rules="all"><caption><b>Table 8 </b>datastore field data structure description</caption><thead align="left"><tr id="dds_api_0020__dds_api_0020_row70524471753"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="dds_api_0020__dds_api_0020_p343772981753">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="dds_api_0020__dds_api_0020_p330977911753">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="dds_api_0020__dds_api_0020_p636754041753">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.42424242424242%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="dds_api_0020__dds_api_0020_p574120414014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__dds_api_0020_row216489991753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p1521482415580">type</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p42146248583">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p13214192410581">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p5562520192718">Specifies the database type. The value is <strong id="dds_api_0020__dds_api_0020_b954102218238">DDS-Community</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row363844211753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p42144246586">version</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p162141624165815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__dds_api_0020_b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0020__dds_api_0020_b638841714576">3.4</strong> or <strong id="dds_api_0020__dds_api_0020_b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p152141624175815">storage_engine</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p102145249581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__dds_api_0020_ul915212153019"><li id="dds_api_0020__dds_api_0020_li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__dds_api_0020_b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__dds_api_0020_li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__dds_api_0020_b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table119482048538"></a><a name="table119482048538"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table119482048538" frame="border" border="1" rules="all"><caption><b>Table 9 </b>flavor field data structure description</caption><thead align="left"><tr id="dds_api_0020__en-us_topic_0000001337145334_row14800249118"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="dds_api_0020__en-us_topic_0000001337145334_p1662124515111">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="dds_api_0020__en-us_topic_0000001337145334_p11670144519110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="dds_api_0020__en-us_topic_0000001337145334_p15675134514110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="dds_api_0020__en-us_topic_0000001337145334_p203621746403">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__en-us_topic_0000001337145334_row2480924512"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="dds_api_0020__en-us_topic_0000001337145334_p18116152911">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="dds_api_0020__en-us_topic_0000001337145334_p11161852317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="dds_api_0020__en-us_topic_0000001337145334_p121164521715">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="dds_api_0020__en-us_topic_0000001337145334_p21161452619">Specifies the node type.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p369141413331">Valid value:</p>
<ul id="dds_api_0020__en-us_topic_0000001337145334_ul121232613404"><li id="dds_api_0020__en-us_topic_0000001337145334_li161211263409">For a cluster instance, the value can be <strong id="dds_api_0020__en-us_topic_0000001337145334_b10928484446">mongos</strong>, <strong id="dds_api_0020__en-us_topic_0000001337145334_b15983455144410">shard</strong>, or <strong id="dds_api_0020__en-us_topic_0000001337145334_b14732155814414">config</strong>.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li6121726104019">For a replica set instance, the value is <strong id="dds_api_0020__en-us_topic_0000001337145334_b1496317331458">replica</strong>.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li412426134016">For a single node instance, the value is <strong id="dds_api_0020__en-us_topic_0000001337145334_b19013368452">single</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__en-us_topic_0000001337145334_row194801524017"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="dds_api_0020__en-us_topic_0000001337145334_p17946205216">num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="dds_api_0020__en-us_topic_0000001337145334_p179461801727">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="dds_api_0020__en-us_topic_0000001337145334_p1994615016215">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="dds_api_0020__en-us_topic_0000001337145334_p11946207210">Specifies node quantity.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p1946140122">Valid value:</p>
<ul id="dds_api_0020__en-us_topic_0000001337145334_ul16946160926"><li id="dds_api_0020__en-us_topic_0000001337145334_li11589861">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li85836115710">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li119471301229">config: The value is <strong id="dds_api_0020__en-us_topic_0000001337145334_b1318012185488">1</strong>.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li129471904215">replica: The number of nodes can be 3, 5, or 7.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li18947201121">single: The value is <strong id="dds_api_0020__en-us_topic_0000001337145334_b13456642203610">1</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__en-us_topic_0000001337145334_row5161165517286"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="dds_api_0020__en-us_topic_0000001337145334_p131613551280">storage</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="dds_api_0020__en-us_topic_0000001337145334_p616353417350">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="dds_api_0020__en-us_topic_0000001337145334_p3589184744118">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="dds_api_0020__en-us_topic_0000001337145334_p2887384610">Specifies the disk type.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p15929549113710">Valid value: ULTRAHIGH, which indicates the type SSD.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p1514452675914">This parameter is valid for the shard and config nodes of a cluster instance, replica set instances, and single node 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__en-us_topic_0000001337145334_row84801524316"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="dds_api_0020__en-us_topic_0000001337145334_p12619121114318">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="dds_api_0020__en-us_topic_0000001337145334_p45501224145815">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="dds_api_0020__en-us_topic_0000001337145334_p661913115318">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="dds_api_0020__en-us_topic_0000001337145334_p13619151112319">Specifies the disk size.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p15677154212581">This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p16619211039">The value must be a multiple of 10. The unit is GB.</p>
<ul id="dds_api_0020__en-us_topic_0000001337145334_ul116195116311"><li id="dds_api_0020__en-us_topic_0000001337145334_li12431338142919">For a cluster instance, the storage space of a shard node can be 10 to 2000 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__en-us_topic_0000001337145334_li961910111139">For a replica set instance, the value ranges from 10 to 2000.</li><li id="dds_api_0020__en-us_topic_0000001337145334_li1061913111837">For a single node instance, the value ranges from 10 to 1000.</li></ul>
</td>
</tr>
<tr id="dds_api_0020__en-us_topic_0000001337145334_row13588338389"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="dds_api_0020__en-us_topic_0000001337145334_p1877334110385">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="dds_api_0020__en-us_topic_0000001337145334_p77801941143817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="dds_api_0020__en-us_topic_0000001337145334_p13788124173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="dds_api_0020__en-us_topic_0000001337145334_p1798051252915">Specifies the resource specification code. For details about how to obtain the value, see the response values of <strong id="dds_api_0020__en-us_topic_0000001337145334_b382751042416">spec_code</strong> in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
<p id="dds_api_0020__en-us_topic_0000001337145334_p17827125193419">In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0020__table59521648930"></a><a name="table59521648930"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table59521648930" frame="border" border="1" rules="all"><caption><b>Table 10 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="dds_api_0020__dds_api_0020_row13463201495"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.2.5.1.1"><p id="dds_api_0020__dds_api_0020_p258122019911"><strong id="dds_api_0020__dds_api_0020_b3515421175117">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.4.2.5.1.2"><p id="dds_api_0020__dds_api_0020_p47172016918"><strong id="dds_api_0020__dds_api_0020_b842352706102346_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.4.2.5.1.3"><p id="dds_api_0020__dds_api_0020_p19887204920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.4.2.1.4.2.5.1.4"><p id="dds_api_0020__dds_api_0020_p542012552010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__dds_api_0020_row12114172014914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p1912612020911">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p81383201395">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p13150162018916">String</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="dds_api_0020__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__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__dds_api_0020_ul73551635192814"><li id="dds_api_0020__dds_api_0020_li13765154012810">The <strong id="dds_api_0020__dds_api_0020_b8466258394">HH</strong> value must be 1 greater than the <strong id="dds_api_0020__dds_api_0020_b174669581595">hh</strong> value.</li><li id="dds_api_0020__dds_api_0020_li1510111915298">The values of <strong id="dds_api_0020__dds_api_0020_b13214152101015">mm</strong> and <strong id="dds_api_0020__dds_api_0020_b321610214106">MM</strong> must be the same and must be set to <strong id="dds_api_0020__dds_api_0020_b1421618251018">00</strong>.</li><li id="dds_api_0020__dds_api_0020_li6314191214591">If this parameter is not transferred, the default backup time window is set to <strong id="dds_api_0020__dds_api_0020_b46791923938">00:00-01:00</strong>.</li></ul>
<p id="dds_api_0020__dds_api_0020_p59342194324">Example value:</p>
<p id="dds_api_0020__dds_api_0020_p1520917507251">23:00-00:00</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row111950203915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p10206620196">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p421932012920">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p111662049164812">String</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p19255132017913">Specifies the number of days to retain the generated backup files.</p>
<p id="dds_api_0020__dds_api_0020_p1627115206911">The value range is from 0 to 732.</p>
<ul id="dds_api_0020__dds_api_0020_ul20536122725718"><li id="dds_api_0020__dds_api_0020_li10536027165717">If this parameter is set to <strong id="dds_api_0020__dds_api_0020_b842352706112318">0</strong>, the automated backup policy is not set.</li><li id="dds_api_0020__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>
<div class="tablenoborder"><a name="dds_api_0020__table1695414482318"></a><a name="table1695414482318"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0020__table1695414482318" frame="border" border="1" rules="all"><caption><b>Table 11 </b>tags field data structure description</caption><thead align="left"><tr id="dds_api_0020__dds_api_0020_row1830265543113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.5.2.5.1.1"><p id="dds_api_0020__dds_api_0020_p1130225511315">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.5.2.5.1.2"><p id="dds_api_0020__dds_api_0020_p430295516313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.5.2.5.1.3"><p id="dds_api_0020__dds_api_0020_p830235563115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.4.2.1.5.2.5.1.4"><p id="dds_api_0020__dds_api_0020_p1030255513119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0020__dds_api_0020_row11302185503113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p18491328347">key</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.5.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p849142123413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p1349115253411">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.5.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p12491723341">Tag key. The value can contain a maximum of 36 unicode characters.</p>
<p id="dds_api_0020__dds_api_0020_p2668123173416">The key cannot be left blank or an empty string.</p>
<p id="dds_api_0020__dds_api_0020_p14912213412">The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row03030556312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p13491112183416">value</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.5.2.5.1.2 "><p id="dds_api_0020__dds_api_0020_p1849118213414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p24916219348">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.5.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p1258913463419">Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string.</p>
<p id="dds_api_0020__dds_api_0020_p4491152173417">The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</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": "4.0",
"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",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"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": "23:00-00:00",
"keep_days": "8"
},
"enterprise_project_id": "",
"ssl_option":"1",
"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</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": "4.0",
"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",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "ReplicaSet",
"flavor": [
{
"type": "replica",
"num": "1",
"spec_code": "dds.mongodb.s2.medium.4.repset",
"size": "30"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "7"
},
"enterprise_project_id": "",
"ssl_option":"1",
"job_id": "2408417d-fd4b-40ae-bec6-e09ce594eb5f",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</pre>
</div>
<div class="p" id="dds_api_0020__p14297105431615">Single node instance:<pre class="codeblock" id="dds_api_0020__codeblock186251378171">{
"id": "520c58ba00a3497e97ce0b9604874dd6in02",
"name": "test-singlenode",
"datastore": {
"type": "DDS-Community",
"version": "4.0",
"storage_engine": "wiredTiger"
},
"created": "2019-01-15 12:08:11",
"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",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Single",
"flavor": [
{
"type": "single",
"num": "1",
"spec_code": "dds.mongodb.s2.medium.4.single",
"size": "30"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "7"
},
"enterprise_project_id": "",
"ssl_option":"1",
"job_id": "46b65a13-3d52-4c58-a29b-4085d563dc9b",
"tags" : [{
"key" : "dds001",
"value" : "dds001"
}]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0020__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0020__en-us_topic_0000001387505349_p16131712193312">Status Code:202.</p>
<p id="dds_api_0020__en-us_topic_0000001387505349_p480617135329">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