lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0038.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

840 lines
66 KiB
HTML
Raw Permalink Blame History

<a name="dds_api_0038"></a><a name="dds_api_0038"></a>
<h1 class="topictitle1">Restoring Data to a New DB Instance</h1>
<div id="body0000001071512479"><div class="section" id="dds_api_0038__section179778465144"><h4 class="sectiontitle">Function</h4><p id="dds_api_0038__p10342124771415">This API is used to restore a backup to a new DB instance.</p>
</div>
<div class="section" id="dds_api_0038__section9979184691415"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0038__ul1834204718142"><li id="dds_api_0038__li7342147101416">The database type of the destination DB instance must be the same as that of the source DB instance.</li><li id="dds_api_0038__li612255918235">Currently, only replica set instances and cluster instances 4.0 can be restored to a new instance and to any point in time.</li></ul>
</div>
<div class="section" id="dds_api_0038__section6982746201418"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0038__ul9342547191420"><li id="dds_api_0038__li93421647151410">URI format<p id="dds_api_0038__p334284721413"><a name="dds_api_0038__li93421647151410"></a><a name="li93421647151410"></a>POST https://{Endpoint}/v3/{project_id}/instances</p>
</li><li id="dds_api_0038__li8342174741417">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table1898410469148" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0038__row153421647161414"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0038__p5342347111418">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0038__p43421847111417">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0038__p1234254751411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row4342847201419"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0038__p123421476147">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0038__p1434213474141">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0038__p1534213475147">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_0038__section6991154614142"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0038__ul1534294717140"><li id="dds_api_0038__li19342164781412">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table1832847161417" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0038__row5342134717143"><th align="left" class="cellrowborder" valign="top" width="20.407959204079592%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0038__p834334791410">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0038__p3343347191410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.447755224477554%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0038__p183431147161413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.75622437756224%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0038__p1434374715145">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row734314710143"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p6343174710142">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p8343947161413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p153436477142">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p1434310478146">Specifies the DB instance name. The instance name can be the same as an existing instance name.</p>
<ul id="dds_api_0038__ul1444173811511"><li id="dds_api_0038__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_0038__row17343104718145"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p1534314712142">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p163438476145">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p13439473145">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p16343847191413">Specifies the AZ ID.</p>
<p id="dds_api_0038__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_0038__row6343174721419"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p1634311472145">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p13432047161413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p3343134712144">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p17697152285019">Specifies the VPC ID.</p>
<p id="dds_api_0038__p1478210342163">For details about how to obtain this parameter value, see section "Virtual Private Cloud" in the <em id="dds_api_0038__i15356175015503">Virtual Private Cloud API Reference</em>.</p>
<p id="dds_api_0038__p9343114717145">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_0038__row183431047201420"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p4343144713143">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p1834394718142">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p33431547171413">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p135717227538">Specifies the subnet ID.</p>
<p id="dds_api_0038__p1659101810176">For details about how to obtain this parameter value, see section "Subnet" in the <em id="dds_api_0038__i15583623651">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="dds_api_0038__row163431472144"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p934324712148">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p534384714148">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p13431947151413">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p123438473144">Specifies the ID of the security group where a specified DB instance belongs to.</p>
<p id="dds_api_0038__p12560193118176">For details about how to obtain this parameter value, see section "Security Group" in the <em id="dds_api_0038__i45149617613">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="dds_api_0038__row234354718143"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p113431347161414">password</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p2343447131412">No</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p9343194711410">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p18343447131410">Specifies the database password.</p>
<p id="dds_api_0038__p18343747131416">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_0038__p6343144751419">Enter a strong password to improve security, preventing security risks such as brute force cracking.</p>
</td>
</tr>
<tr id="dds_api_0038__row163431847161414"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p5343194716148">disk_encryption_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p13433476146">No</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p23431147151417">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p93431647171417">The key ID used for disk encryption. The string must comply with UUID regular expression rules.</p>
<p id="dds_api_0038__p143436476147">If this parameter is not transferred, disk encryption is not performed.</p>
</td>
</tr>
<tr id="dds_api_0038__row1234384741414"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p16343154715145">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p1734344721416">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p153432047151418">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p103437477143">Specifies the instance specifications. For more information, see <a href="#dds_api_0038__table206664717143">Table 4</a>.</p>
<p id="dds_api_0038__p133434476142">For details about how to obtain the value, see the parameter value in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row11343047141414"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p16343134712147">restore_point</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p8343247141412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p103430476145">Object</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p1734374751417">Specifies the details about the backup to be restored to a new DB instance. For more information, see <a href="#dds_api_0038__table663124711145">Table 3</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row434312479143"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p1134374721419">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p1134317473141">No</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p11343547131412">Object</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p183431847141415">Specifies the advanced backup policy. For more information, see <a href="#dds_api_0038__table289547161412">Table 5</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row934324720148"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p13431447161416">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p33431347171417">No</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p1434344717146">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p7343124741410">Specifies the enterprise project ID.</p>
<ul id="dds_api_0038__ul534374761411"><li id="dds_api_0038__li17343747131417">This parameter is not transferred for users who have not enabled the enterprise multi-project service.</li><li id="dds_api_0038__li93431947171419">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>
</td>
</tr>
<tr id="dds_api_0038__row143431479146"><td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0038__p16343247111413">ssl_option</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0038__p1834310474143">No</p>
</td>
<td class="cellrowborder" valign="top" width="22.447755224477554%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0038__p18343154716140">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.75622437756224%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0038__p534324721418">Specifies whether to enable or disable SSL.</p>
<p id="dds_api_0038__p10343134712144">Valid value:</p>
<ul id="dds_api_0038__ul2038619293591"><li id="dds_api_0038__li1338642915591">The value <strong id="dds_api_0038__b138379405919">0</strong> indicates that SSL is disabled by default.</li><li id="dds_api_0038__li643063295920">The value <strong id="dds_api_0038__b062913503919">1</strong> indicates that SSL is enabled by default.</li></ul>
<p id="dds_api_0038__p13344447181419">If this parameter is not transferred, SSL is enabled by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0038__table663124711145"></a><a name="table663124711145"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table663124711145" frame="border" border="1" rules="all"><caption><b>Table 3 </b>restore_point field data structure description</caption><thead align="left"><tr id="dds_api_0038__row1734464781418"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="dds_api_0038__p1034484741412">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="dds_api_0038__p2034464714140">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="dds_api_0038__p1034420475147">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="dds_api_0038__p73447477141">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row1344194711143"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0038__p10344154714145">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0038__p18344184712144">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0038__p534474714144">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0038__p81513561604">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
<ul id="dds_api_0038__ul034410221667"><li id="dds_api_0038__li1344722867">This parameter is optional when <strong id="dds_api_0038__b1094134221217">type</strong> is set to <strong id="dds_api_0038__b312244410124">backup</strong>.</li><li id="dds_api_0038__li143444221968">This parameter is mandatory when <strong id="dds_api_0038__b993415161210">type</strong> is set to <strong id="dds_api_0038__b225665541216">timestamp</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__row106471824549"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0038__p26478245419">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0038__p1272016480612">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0038__p46475241341">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0038__p18515141561">Specifies the recovery mode. The enumerated values are as follows:</p>
<ul id="dds_api_0038__ul185151011665"><li id="dds_api_0038__li651519116619"><strong id="dds_api_0038__b10643134351410">backup</strong>: indicates restoration from backup files. In this mode, <strong id="dds_api_0038__b77104507140">backup_id</strong> is mandatory when <strong id="dds_api_0038__b0277143716711">type</strong> is optional.</li><li id="dds_api_0038__li1751581166"><strong id="dds_api_0038__b1172185210151">timestamp</strong>: indicates point-in-time restoration. In this mode, <strong id="dds_api_0038__b1353455612157">restore_time</strong> is mandatory when <span class="parmname" id="dds_api_0038__parmname431421818472"><b>type</b></span> is mandatory.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__row425113013410"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0038__p657094913420">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0038__p25701649943">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0038__p25701491445">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0038__p3908133813716">Specifies the ID of the backup to be restored. This parameter must be specified when the backup file is used for restoration.</p>
<div class="note" id="dds_api_0038__note169502372615"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0038__p10951133710610">When <strong id="dds_api_0038__b11903163321619">type</strong> is not mandatory, <strong id="dds_api_0038__b3703133814161">backup_id</strong> is mandatory.</p>
</div></div>
</td>
</tr>
<tr id="dds_api_0038__row1214611349418"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0038__p114618345417">restore_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0038__p1514653416411">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0038__p1614683416418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0038__p937815291715">Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.</p>
<div class="note" id="dds_api_0038__note56828521865"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0038__p177032520611">When <strong id="dds_api_0038__b84235270610114">type</strong> is mandatory, <strong id="dds_api_0038__b1522582720171">restore_time</strong> is mandatory.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="dds_api_0038__p1344184717145">
<div class="tablenoborder"><a name="dds_api_0038__table206664717143"></a><a name="table206664717143"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table206664717143" frame="border" border="1" rules="all"><caption><b>Table 4 </b>flavor field data structure description</caption><thead align="left"><tr id="dds_api_0038__row1834454720141"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.3.1.2.5.1.1"><p id="dds_api_0038__p1434418470145">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.1.2.5.1.2"><p id="dds_api_0038__p1634417470149">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.3.1.2.5.1.3"><p id="dds_api_0038__p1234404717140">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.4.2.1.3.1.2.5.1.4"><p id="dds_api_0038__p15344164714143">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row6344547131410"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.1 "><p id="dds_api_0038__p1934414475142">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.1.2.5.1.2 "><p id="dds_api_0038__p173441847121420">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.3 "><p id="dds_api_0038__p13344947191413">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.3.1.2.5.1.4 "><p id="dds_api_0038__p5344194771410">Specifies the node type.</p>
<p id="dds_api_0038__p17344847121419">Valid value:</p>
<ul id="dds_api_0038__ul23441547151410"><li id="dds_api_0038__li9344547111415">For a cluster instance, the value can be <strong id="dds_api_0038__b1752744141719">mongos</strong>, <strong id="dds_api_0038__b18540448174">shard</strong>, or <strong id="dds_api_0038__b45614443172">config</strong>.</li><li id="dds_api_0038__li43442478143">For a replica set instance, the value is <strong id="dds_api_0038__b838312514179">replica</strong>.</li><li id="dds_api_0038__li834424718142">For a single node instance, the value is <strong id="dds_api_0038__b124767535178">single</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__row734412477144"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.1 "><p id="dds_api_0038__p10344194713141">num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.1.2.5.1.2 "><p id="dds_api_0038__p1834404718142">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.3 "><p id="dds_api_0038__p1734411471144">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.3.1.2.5.1.4 "><p id="dds_api_0038__p7344154716147">Specifies node quantity.</p>
<p id="dds_api_0038__p2034410473149">Valid value:</p>
<ul id="dds_api_0038__ul15344174712143"><li id="dds_api_0038__li75131112816">This parameter is not transferred for shard nodes.</li><li id="dds_api_0038__li1772413451773">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0038__li1344184711418">config: The value is <strong id="dds_api_0038__b19557182120208">1</strong>.</li><li id="dds_api_0038__li15344164741414">replica: The value is <strong id="dds_api_0038__b2626824162010">1</strong>.</li><li id="dds_api_0038__li034417479142">single: The value is <strong id="dds_api_0038__b312127182011">1</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__row133441047141416"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.1 "><p id="dds_api_0038__p64651814155013">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.1.2.5.1.2 "><p id="dds_api_0038__p12465131485016">No</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.3 "><p id="dds_api_0038__p154651914195016">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.3.1.2.5.1.4 "><p id="dds_api_0038__p1646511425012">Specifies the disk size.</p>
<p id="dds_api_0038__p1546521495014">The value must be a multiple of 10. The unit is GB.</p>
<ul id="dds_api_0038__ul64651814195015"><li id="dds_api_0038__li246519141507">In a cluster instance, the shard size ranges from 10 GB to 2000 GB and must be greater than or equal to the disk size of the original instance. The config size can only be 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_0038__li15465814125012">In a replica set instance, the disk size ranges from 10 GB to 2000 GB and must be greater than or equal to the disk size of the original instance.</li><li id="dds_api_0038__li7465214175011">In a single node instance, the disk size ranges from 10 GB to 1000 GB and must be greater than or equal to the disk size of the original instance.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__row5344147141410"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.1 "><p id="dds_api_0038__p1534419478145">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.1.2.5.1.2 "><p id="dds_api_0038__p153443473141">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.3.1.2.5.1.3 "><p id="dds_api_0038__p2034415471148">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.3.1.2.5.1.4 "><p id="dds_api_0038__p534414781412">Specifies the resource specification code. For details about how to obtain the value, see the parameter value in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="p" id="dds_api_0038__p73441475143">
<div class="tablenoborder"><a name="dds_api_0038__table289547161412"></a><a name="table289547161412"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table289547161412" 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_0038__row15345114741410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.1.2.5.1.1"><p id="dds_api_0038__p19345447161415">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.4.1.2.5.1.2"><p id="dds_api_0038__p1934584771417">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.1.2.5.1.3"><p id="dds_api_0038__p834564720144">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.4.2.1.4.1.2.5.1.4"><p id="dds_api_0038__p934511476148">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row18345124712143"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.1.2.5.1.1 "><p id="dds_api_0038__p163455479148">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.4.1.2.5.1.2 "><p id="dds_api_0038__p113451047191410">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.1.2.5.1.3 "><p id="dds_api_0038__p234544781410">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.4.1.2.5.1.4 "><p id="dds_api_0038__p11345154751410">Specifies the backup time window. Automated backups will be triggered during the backup time window.</p>
<p id="dds_api_0038__p53451947121419">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_0038__ul1634534711412"><li id="dds_api_0038__li83454471146">The <strong id="dds_api_0038__b159541305288">HH</strong> value must be 1 greater than the <strong id="dds_api_0038__b109651107287">hh</strong> value.</li><li id="dds_api_0038__li1734510472146">The values of <strong id="dds_api_0038__b14471335282">mm</strong> and <strong id="dds_api_0038__b247218316287">MM</strong> must be the same and must be set to <strong id="dds_api_0038__b84729362812">00</strong>.</li></ul>
<p id="dds_api_0038__p1134511473146">Example value:</p>
<p id="dds_api_0038__p1473743616301">23:00-00:00</p>
</td>
</tr>
<tr id="dds_api_0038__row12345114718144"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.1.2.5.1.1 "><p id="dds_api_0038__p43451476141">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.4.1.2.5.1.2 "><p id="dds_api_0038__p1434564715148">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.1.2.5.1.3 "><p id="dds_api_0038__p1034564712148">String</p>
</td>
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.4.1.2.5.1.4 "><p id="dds_api_0038__p1345114791415">Specifies the number of days to retain the generated backup files.</p>
<p id="dds_api_0038__p43451247101419">The value range is from 0 to 732.</p>
<ul id="dds_api_0038__ul17345547171411"><li id="dds_api_0038__li143453471141">If this parameter is set to <strong id="dds_api_0038__b1031153282811">0</strong>, the automated backup policy is not set.</li><li id="dds_api_0038__li13464472142">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>
<div class="note" id="dds_api_0038__note12992146141420"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0038__p17346104710148">The values of <strong id="dds_api_0038__b98311551132820">region</strong> and <strong id="dds_api_0038__b583275118280">availability_zone</strong> are used as examples.</p>
</div></div>
</li></ul>
<ul id="dds_api_0038__ul183460479140"><li id="dds_api_0038__li7346104711415">Request example<p id="dds_api_0038__p167737288369"><a name="dds_api_0038__li7346104711415"></a><a name="li7346104711415"></a>POST https://dds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances</p>
<p id="dds_api_0038__p16181728113620">Restoring a backup to a new cluster instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock4191028103613">{
"name": "test-cluster-01",
"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#%0_",
"restore_point": {
"backup_id": "8f643d252d834a4c916b2db4322f99552734"
},
"flavor": [{
"type": "mongos",
"num": 2,
"spec_code": "dds.mongodb.c3.medium.4.mongos"
},
{
"type": "shard",
"size": "40",
"spec_code": "dds.mongodb.c3.medium.4.shard"
},
{
"type": "config",
"num": 1,
"size": "20",
"spec_code": "dds.mongodb.c3.large.2.config"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "8"
}
}</pre>
<p id="dds_api_0038__p1719628133617">Restoring a backup to a new replica set instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock3201028123617">{
"name": "test-replicaset",
"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#%0_",
"restore_point": {
"backup_id": "8f643d252d834a4c916b2db4322f99552734"
},
"flavor": [
{
"type": "replica",
"num": 1,
"spec_code": "dds.mongodb.s2.medium.4.repset"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "8"
}
}</pre>
<p id="dds_api_0038__p102020286360">Restoring a backup to a new single node instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock192052863617">{
"name": "test-singlenode",
"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#%0_",
"restore_point": {
"backup_id": "8f643d252d834a4c916b2db4322f99552734"
},
"flavor": [
{
"type": "single",
"num": 1,
"spec_code": "dds.mongodb.c3.medium.4.single"
}
],
"backup_strategy": {
"start_time": "23:00-00:00",
"keep_days": "8"
}
}</pre>
<p id="dds_api_0038__p5208284363">Restoring a backup to a new replica set instance at a point in time:</p>
<pre class="codeblock" id="dds_api_0038__codeblock132192819368">{
"name": "replica-liuyunj1",
"availability_zone": "az1xahz",
"vpc_id": "dcdadabc-efed-4518-8b34-4af66fcd97e7",
"subnet_id": "4a9348f2-f232-4700-a440-2f1641d80960",
"security_group_id": "c57b9db2-cccb-4c0d-b058-7ea51dda0c99",
"flavor": [
{
"type": "replica",
"num": 1,
"size": "100",
"spec_code": "dds.mongodb.c3.large.2.repset"
}
],
"backup_strategy": {
"start_time": "08:00-09:00",
"keep_days": "8"
},
"restore_point": {
"instance_id": "d5833c2854a4486cb7960f829269e211in02",
"type": "timestamp",
"restore_time": 1607689584000
},
"ssl_option": "1"
}</pre>
<p id="dds_api_0038__p102192813615"></p>
</li></ul>
</div>
<div class="section" id="dds_api_0038__section211784781414"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0038__ul63471247151412"><li id="dds_api_0038__li5347447181410">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table512054721419" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0038__row9347174717145"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0038__p1347104711144">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.61%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0038__p5347144715148">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.82%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0038__p113471447181420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row173475473141"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p14347164710140">id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p3347447151415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p434704717140">Indicates the DB instance ID,</p>
</td>
</tr>
<tr id="dds_api_0038__row10347547181410"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p1134714710147">name</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p134715473145">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p7347154791418">which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row203479470143"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p203471247151415">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p33471347171411">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p340916273255">Indicates the database information, which is the same as the request parameter. For more information, see <a href="#dds_api_0038__table228903751753">Table 7</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row3347347131413"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p334714476145">created</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p2034714476148">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p173474479143">Indicates the creation time in the following format: yyyy-mm-dd hh:mm:ss.</p>
</td>
</tr>
<tr id="dds_api_0038__row10347204711419"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p1134713477144">status</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p134704715149">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p8347114731411">Indicates the DB instance status. The value is <span class="parmvalue" id="dds_api_0038__parmvalue15881151613215"><b>creating</b></span>.</p>
</td>
</tr>
<tr id="dds_api_0038__row17347174761416"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p163474472147">region</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p113476476149">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p10347184731416">Indicates the region ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row23471047161410"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p734754716141">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p143471447111420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p15347134715146">Indicates the AZ ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row1234704751411"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p163471478146">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p173477472146">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p634774714146">Indicates the VPC ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row934714761414"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p103471347181413">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p2034719479142">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p9347154716149">Indicates the subnet ID, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row18347184714140"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p33471847181420">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p634774711143">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p8347174716148">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_0038__row4347204712148"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p19347184791410">disk_encryption_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p03474475144">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p1434714716145">Indicates the ID of the disk encryption key, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row1834774791410"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p3347647181411">mode</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p4347174761418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p1334714771413">Indicates the instance type, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0038__row163471247171410"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p20347647161417">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p5347134716147">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p1334774701410">Indicates the instance specification, which is the same as the request parameter. For more information, see <a href="#dds_api_0038__table119482048538">Table 8</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row9347947101415"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p163475472141">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p8347154731414">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p63479477140">Indicates the advanced backup policy, which is the same as the request parameter. For more information, see <a href="#dds_api_0038__table59521648930">Table 9</a>.</p>
</td>
</tr>
<tr id="dds_api_0038__row7347104741417"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p183477474148">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p173478470146">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p1347947161412">Indicates the enterprise project ID. If the value is <strong id="dds_api_0038__b5622201915338">0</strong>, the resource belongs to the default enterprise project.</p>
</td>
</tr>
<tr id="dds_api_0038__row1234734715148"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p734764710142">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p123473475146">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p334814714146">Indicates the ID of the workflow for creating a DB instance.</p>
</td>
</tr>
<tr id="dds_api_0038__row383651144916"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0038__p497012201508">ssl_option</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0038__p10970132010013">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0038__p74671737135118">Indicates whether to enable SSL, which functions the same as the request parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0038__table228903751753"></a><a name="table228903751753"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table228903751753" frame="border" border="1" rules="all"><caption><b>Table 7 </b>datastore field data structure description</caption><thead align="left"><tr id="dds_api_0038__row70524471753"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.5.2.1.2.2.5.1.1"><p id="dds_api_0038__p343772981753">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.5.2.1.2.2.5.1.2"><p id="dds_api_0038__p330977911753">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.5.2.1.2.2.5.1.3"><p id="dds_api_0038__p636754041753">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.42424242424242%" id="mcps1.3.5.2.1.2.2.5.1.4"><p id="dds_api_0038__p574120414014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__row216489991753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.5.2.1.2.2.5.1.1 "><p id="dds_api_0038__p1521482415580">type</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.5.2.1.2.2.5.1.2 "><p id="dds_api_0038__p42146248583">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p13214192410581">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p5562520192718">Specifies the database type. The value is <strong id="dds_api_0038__b954102218238">DDS-Community</strong>.</p>
</td>
</tr>
<tr id="dds_api_0038__row363844211753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.5.2.1.2.2.5.1.1 "><p id="dds_api_0038__p42144246586">version</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.5.2.1.2.2.5.1.2 "><p id="dds_api_0038__p162141624165815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__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_0038__b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0038__b638841714576">3.4</strong> or <strong id="dds_api_0038__b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0038__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.5.2.1.2.2.5.1.1 "><p id="dds_api_0038__p152141624175815">storage_engine</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.5.2.1.2.2.5.1.2 "><p id="dds_api_0038__p102145249581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0038__ul915212153019"><li id="dds_api_0038__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0038__b18610160885">rocksDB</strong>.</li><li id="dds_api_0038__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_0038__b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0038__table119482048538"></a><a name="table119482048538"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table119482048538" frame="border" border="1" rules="all"><caption><b>Table 8 </b>flavor field data structure description</caption><thead align="left"><tr id="dds_api_0038__en-us_topic_0000001337145334_row14800249118"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.5.2.1.3.2.5.1.1"><p id="dds_api_0038__en-us_topic_0000001337145334_p1662124515111">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.3.2.5.1.2"><p id="dds_api_0038__en-us_topic_0000001337145334_p11670144519110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.2.1.3.2.5.1.3"><p id="dds_api_0038__en-us_topic_0000001337145334_p15675134514110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.5.2.1.3.2.5.1.4"><p id="dds_api_0038__en-us_topic_0000001337145334_p203621746403">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__en-us_topic_0000001337145334_row2480924512"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.3.2.5.1.1 "><p id="dds_api_0038__en-us_topic_0000001337145334_p18116152911">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.5.1.2 "><p id="dds_api_0038__en-us_topic_0000001337145334_p11161852317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.2.5.1.3 "><p id="dds_api_0038__en-us_topic_0000001337145334_p121164521715">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.5.2.1.3.2.5.1.4 "><p id="dds_api_0038__en-us_topic_0000001337145334_p21161452619">Specifies the node type.</p>
<p id="dds_api_0038__en-us_topic_0000001337145334_p369141413331">Valid value:</p>
<ul id="dds_api_0038__en-us_topic_0000001337145334_ul121232613404"><li id="dds_api_0038__en-us_topic_0000001337145334_li161211263409">For a cluster instance, the value can be <strong id="dds_api_0038__en-us_topic_0000001337145334_b10928484446">mongos</strong>, <strong id="dds_api_0038__en-us_topic_0000001337145334_b15983455144410">shard</strong>, or <strong id="dds_api_0038__en-us_topic_0000001337145334_b14732155814414">config</strong>.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li6121726104019">For a replica set instance, the value is <strong id="dds_api_0038__en-us_topic_0000001337145334_b1496317331458">replica</strong>.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li412426134016">For a single node instance, the value is <strong id="dds_api_0038__en-us_topic_0000001337145334_b19013368452">single</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__en-us_topic_0000001337145334_row194801524017"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.3.2.5.1.1 "><p id="dds_api_0038__en-us_topic_0000001337145334_p17946205216">num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.5.1.2 "><p id="dds_api_0038__en-us_topic_0000001337145334_p179461801727">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.2.5.1.3 "><p id="dds_api_0038__en-us_topic_0000001337145334_p1994615016215">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.5.2.1.3.2.5.1.4 "><p id="dds_api_0038__en-us_topic_0000001337145334_p11946207210">Specifies node quantity.</p>
<p id="dds_api_0038__en-us_topic_0000001337145334_p1946140122">Valid value:</p>
<ul id="dds_api_0038__en-us_topic_0000001337145334_ul16946160926"><li id="dds_api_0038__en-us_topic_0000001337145334_li11589861">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li85836115710">mongos: The value ranges from 2 to 32.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li119471301229">config: The value is <strong id="dds_api_0038__en-us_topic_0000001337145334_b1318012185488">1</strong>.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li129471904215">replica: The number of nodes can be 3, 5, or 7.</li><li id="dds_api_0038__en-us_topic_0000001337145334_li18947201121">single: The value is <strong id="dds_api_0038__en-us_topic_0000001337145334_b13456642203610">1</strong>.</li></ul>
</td>
</tr>
<tr id="dds_api_0038__en-us_topic_0000001337145334_row5161165517286"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.3.2.5.1.1 "><p id="dds_api_0038__en-us_topic_0000001337145334_p131613551280">storage</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.5.1.2 "><p id="dds_api_0038__en-us_topic_0000001337145334_p616353417350">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.2.5.1.3 "><p id="dds_api_0038__en-us_topic_0000001337145334_p3589184744118">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.5.2.1.3.2.5.1.4 "><p id="dds_api_0038__en-us_topic_0000001337145334_p2887384610">Specifies the disk type.</p>
<p id="dds_api_0038__en-us_topic_0000001337145334_p15929549113710">Valid value: ULTRAHIGH, which indicates the type SSD.</p>
<p id="dds_api_0038__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_0038__en-us_topic_0000001337145334_row84801524316"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.3.2.5.1.1 "><p id="dds_api_0038__en-us_topic_0000001337145334_p12619121114318">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.5.1.2 "><p id="dds_api_0038__en-us_topic_0000001337145334_p45501224145815">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.2.5.1.3 "><p id="dds_api_0038__en-us_topic_0000001337145334_p661913115318">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.5.2.1.3.2.5.1.4 "><p id="dds_api_0038__en-us_topic_0000001337145334_p13619151112319">Specifies the disk size.</p>
<p id="dds_api_0038__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_0038__en-us_topic_0000001337145334_p16619211039">The value must be a multiple of 10. The unit is GB.</p>
<ul id="dds_api_0038__en-us_topic_0000001337145334_ul116195116311"><li id="dds_api_0038__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_0038__en-us_topic_0000001337145334_li961910111139">For a replica set instance, the value ranges from 10 to 2000.</li><li id="dds_api_0038__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_0038__en-us_topic_0000001337145334_row13588338389"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.3.2.5.1.1 "><p id="dds_api_0038__en-us_topic_0000001337145334_p1877334110385">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.5.1.2 "><p id="dds_api_0038__en-us_topic_0000001337145334_p77801941143817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.2.5.1.3 "><p id="dds_api_0038__en-us_topic_0000001337145334_p13788124173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.5.2.1.3.2.5.1.4 "><p id="dds_api_0038__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_0038__en-us_topic_0000001337145334_b382751042416">spec_code</strong> in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
<p id="dds_api_0038__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_0038__table59521648930"></a><a name="table59521648930"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0038__table59521648930" frame="border" border="1" rules="all"><caption><b>Table 9 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="dds_api_0038__dds_api_0020_row13463201495"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.4.2.5.1.1"><p id="dds_api_0038__dds_api_0020_p258122019911"><strong id="dds_api_0038__dds_api_0020_b3515421175117">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.5.2.1.4.2.5.1.2"><p id="dds_api_0038__dds_api_0020_p47172016918"><strong id="dds_api_0038__dds_api_0020_b842352706102346_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.2.1.4.2.5.1.3"><p id="dds_api_0038__dds_api_0020_p19887204920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.5.2.1.4.2.5.1.4"><p id="dds_api_0038__dds_api_0020_p542012552010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0038__dds_api_0020_row12114172014914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.4.2.5.1.1 "><p id="dds_api_0038__dds_api_0020_p1912612020911">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.4.2.5.1.2 "><p id="dds_api_0038__dds_api_0020_p81383201395">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.1.4.2.5.1.3 "><p id="dds_api_0038__dds_api_0020_p13150162018916">String</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.5.2.1.4.2.5.1.4 "><p id="dds_api_0038__dds_api_0020_p8983181183415">Specifies the backup time window. Automated backups will be triggered during the backup time window.</p>
<p id="dds_api_0038__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_0038__dds_api_0020_ul73551635192814"><li id="dds_api_0038__dds_api_0020_li13765154012810">The <strong id="dds_api_0038__dds_api_0020_b8466258394">HH</strong> value must be 1 greater than the <strong id="dds_api_0038__dds_api_0020_b174669581595">hh</strong> value.</li><li id="dds_api_0038__dds_api_0020_li1510111915298">The values of <strong id="dds_api_0038__dds_api_0020_b13214152101015">mm</strong> and <strong id="dds_api_0038__dds_api_0020_b321610214106">MM</strong> must be the same and must be set to <strong id="dds_api_0038__dds_api_0020_b1421618251018">00</strong>.</li><li id="dds_api_0038__dds_api_0020_li6314191214591">If this parameter is not transferred, the default backup time window is set to <strong id="dds_api_0038__dds_api_0020_b46791923938">00:00-01:00</strong>.</li></ul>
<p id="dds_api_0038__dds_api_0020_p59342194324">Example value:</p>
<p id="dds_api_0038__dds_api_0020_p1520917507251">23:00-00:00</p>
</td>
</tr>
<tr id="dds_api_0038__dds_api_0020_row111950203915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.4.2.5.1.1 "><p id="dds_api_0038__dds_api_0020_p10206620196">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.1.4.2.5.1.2 "><p id="dds_api_0038__dds_api_0020_p421932012920">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.1.4.2.5.1.3 "><p id="dds_api_0038__dds_api_0020_p111662049164812">String</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.5.2.1.4.2.5.1.4 "><p id="dds_api_0038__dds_api_0020_p19255132017913">Specifies the number of days to retain the generated backup files.</p>
<p id="dds_api_0038__dds_api_0020_p1627115206911">The value range is from 0 to 732.</p>
<ul id="dds_api_0038__dds_api_0020_ul20536122725718"><li id="dds_api_0038__dds_api_0020_li10536027165717">If this parameter is set to <strong id="dds_api_0038__dds_api_0020_b842352706112318">0</strong>, the automated backup policy is not set.</li><li id="dds_api_0038__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="note" id="dds_api_0038__note41171477147"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0038__p1134814751419">The values of <strong id="dds_api_0038__b17397172812333">region</strong> and <strong id="dds_api_0038__b11399192853310">availability_zone</strong> are used as examples.</p>
</div></div>
</li></ul>
<ul id="dds_api_0038__ul034874715147"><li id="dds_api_0038__li12348124791417">Response example<p id="dds_api_0038__p17348647171413"><a name="dds_api_0038__li12348124791417"></a><a name="li12348124791417"></a>Cluster instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock163481647191418">{
"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",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Sharding",
"flavor": [
{
"type": "mongos",
"num": "2",
"spec_code": "dds.mongodb.c3.medium.4.mongos"
},
{
"type": "shard",
"num": "2",
"spec_code": "dds.mongodb.c3.medium.4.shard",
"size": "20"
},
{
"type": "config",
"num": "1",
"spec_code": "dds.mongodb.c3.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"
}</pre>
<p id="dds_api_0038__p1348547191413">Replica set instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock53481470143">{
"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",
"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"
}</pre>
<p id="dds_api_0038__p17348124711415">Single node instance:</p>
<pre class="codeblock" id="dds_api_0038__codeblock5348174716143">{
"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",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Single",
"flavor": [
{
"type": "single",
"num": "1",
"spec_code": "dds.mongodb.c3.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"
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0038__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0038__en-us_topic_0000001387505349_p16131712193312">Status Code:202.</p>
<p id="dds_api_0038__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_0038__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0038__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_backup_restore.html">Backup and Restoration</a></div>
</div>
</div>
View Git Blame Copy Permalink