vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/rds/api-ref/en-us_topic_0032347785.html
Ru, Li Yi a37246839c rds_api 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-02-27 10:01:54 +00:00

994 lines
81 KiB
HTML
Raw Blame History

<a name="en-us_topic_0032347785"></a><a name="en-us_topic_0032347785"></a>
<h1 class="topictitle1">Creating a DB Instance</h1>
<div id="body60002101"><div class="section" id="en-us_topic_0032347785__section4284989"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0032347785__p28332047">This API is used to create a single DB instance, primary/standby DB instances, or a read replica.</p>
</div>
<div class="section" id="en-us_topic_0032347785__section38564907"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0032347785__ul13194498"><li id="en-us_topic_0032347785__li51641620">URI format<p id="en-us_topic_0032347785__p62121397"><a name="en-us_topic_0032347785__li51641620"></a><a name="li51641620"></a>PATH: /rds/v1/{project_id}/instances</p>
<p id="en-us_topic_0032347785__p62184411154534">Method: POST</p>
</li><li id="en-us_topic_0032347785__li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347785__row46529701"><th align="left" class="cellrowborder" valign="top" width="20.74%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0032347785__p10809459"><strong id="en-us_topic_0032347785__b842352706102328">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.810000000000002%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0032347785__p3150961"><strong id="en-us_topic_0032347785__b842352706102346">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.449999999999996%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0032347785__p53901255"><strong id="en-us_topic_0032347785__b842352706163417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row27827961145955"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032347785__p184490251502">versionId</p>
</td>
<td class="cellrowborder" valign="top" width="28.810000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032347785__p179760341502">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.449999999999996%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032347785__p467726811502">Specifies the API version. It is case-sensitive and the value is <strong id="en-us_topic_0032347785__b842352706143722">v1</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row3925534"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032347785__p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.810000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032347785__p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.449999999999996%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032347785__p43776822">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0032347785__section11539844"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0032347785__ul36592919"><li id="en-us_topic_0032347785__li60900816">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table6209466312442" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347785__row6512234412442"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.1.2.4.1.1"><p id="en-us_topic_0032347785__p4041853012442"><strong id="en-us_topic_0032347785__b1333949967">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.1.2.4.1.2"><p id="en-us_topic_0032347785__p5267548812442"><strong id="en-us_topic_0032347785__b842352706164541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.1.2.4.1.3"><p id="en-us_topic_0032347785__p3885613912442"><strong id="en-us_topic_0032347785__b999545495">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row6033953012442"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347785__p5566375012442">instance</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347785__p5287375317633">Dictionary data structure.</p>
<p id="en-us_topic_0032347785__p1246986212442">For details on the field description when creating single or primary/standby DB instances, see <a href="#en-us_topic_0032347785__table11236435">Table 3</a>.</p>
<p id="en-us_topic_0032347785__p590235817628">For details on the field description when creating a read replica, see <a href="#en-us_topic_0032347785__table228903751753">Table 4</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347785__p48757463124544">Specifies the detailed DB instance information.</p>
<div class="notice" id="en-us_topic_0032347785__note629684781753"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="en-us_topic_0032347785__p298453971753">RDS for Microsoft SQL Server does not support creating read replicas.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table11236435"></a><a name="table11236435"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table11236435" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instance field data structure (creating single or primary/standby DB instances)</caption><thead align="left"><tr id="en-us_topic_0032347785__row61525259"><th align="left" class="cellrowborder" valign="top" width="29.520000000000003%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0032347785__p17490046"><strong id="en-us_topic_0032347785__b1117733008">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0032347785__p7407659"><strong id="en-us_topic_0032347785__b863368061">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.060000000000002%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0032347785__p63149496"><strong id="en-us_topic_0032347785__b2023782395">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0032347785__p14835533"><strong id="en-us_topic_0032347785__b210250754">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row60827539"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p28083633">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p60181840">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p42890904">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p23411412333">Specifies the DB instance name.</p>
<p id="en-us_topic_0032347785__p112761271615">DB instances of the same type can have same names under the same tenant.</p>
<p id="en-us_topic_0032347785__p61847473">Valid value:</p>
<p id="en-us_topic_0032347785__p13135136181854">The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row56760689"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p34213098">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p19797588">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p60100823">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table64243102">Table 5</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p58520811">Specifies the database information.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row42565233"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p25231885">flavorRef</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p30516772">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p55939488">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p34804713">Specifies the specification ID (<strong id="en-us_topic_0032347785__b15464132919295">flavors.id</strong> in the response message in section <a href="en-us_topic_0032347783.html">Obtaining All DB Instance Specifications</a>).</p>
<p id="en-us_topic_0032347785__p44806966">Valid value:</p>
<p id="en-us_topic_0032347785__p384473214443">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="en-us_topic_0032347785__row49370368"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p39576862">volume</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p51609257">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p19600264">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table10656503">Table 6</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p61513540">Specifies the volume information.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row16540805"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p64736823">region</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p9191297">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p6297612">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p40344576">Specifies the region ID.</p>
<p id="en-us_topic_0032347785__p1978276317427">Valid value:</p>
<p id="en-us_topic_0032347785__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="en-us_topic_0032347785__row9307971"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p15748167">availabilityZone</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p533144">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p43184669">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p8297278">Specifies the AZ ID.</p>
<p id="en-us_topic_0032347785__p6574938217430">Valid value:</p>
<p id="en-us_topic_0032347785__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="en-us_topic_0032347785__row51313205"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p62728917">vpc</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p47877526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p52874399">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p54967961">Specifies the VPC ID. For details about how to obtain this parameter value, see section "Virtual Private Cloud" in the <em id="en-us_topic_0032347785__i842352697165629">Virtual Private Cloud API Reference</em>.</p>
<p id="en-us_topic_0032347785__p23219884">Valid value:</p>
<p id="en-us_topic_0032347785__p48962966144451">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="en-us_topic_0032347785__row15861880"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p9743886">nics</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p51057338">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p42003681">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table2179128">Table 7</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p19042013">Specifies the nics information. For details about how to obtain this parameter value, see section "Subnet" in the <em id="en-us_topic_0032347785__i1727078263">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row66008059"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p45052529">securityGroup</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p25376232">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p42208903">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table4150710">Table 8</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p34431157">Specifies the security group which the RDS DB instance belongs to.</p>
<p id="en-us_topic_0032347785__p41444960">For details about how to obtain this parameter value, see section "Security Group" in the <em id="en-us_topic_0032347785__i13659676">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row31320691125738"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p9447096125742">dbPort</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p27017325125742">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p40919702125742">Int</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p19914101012135">Specifies the database port information.</p>
<ul id="en-us_topic_0032347785__ul10438123672912"><li id="en-us_topic_0032347785__li1643823618291">The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).</li><li id="en-us_topic_0032347785__li10438636192916">The PostgreSQL database port ranges from 2100 to 9500.</li><li id="en-us_topic_0032347785__li2438203662918">The Microsoft SQL Server database port can be 1433 or ranges from 2100 to 9500, excluding 5355 and 5985.</li></ul>
<p id="en-us_topic_0032347785__p6601319181417">If this parameter is not set, the default value is as follows:</p>
<ul id="en-us_topic_0032347785__ul1696512278148"><li id="en-us_topic_0032347785__li25818392140">For MySQL databases, the default value is <strong id="en-us_topic_0032347785__b164181349202913">3306</strong>.</li><li id="en-us_topic_0032347785__li93271730121413">For PostgreSQL databases, the default value is <strong id="en-us_topic_0032347785__b1632725292912">5432</strong>.</li><li id="en-us_topic_0032347785__li12965162714143">For Microsoft SQL Server, the default value is <strong id="en-us_topic_0032347785__b139211955182913">1433</strong>.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0032347785__row37460321"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p14387121">backupStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p24506125">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p38839134">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table49774232">Table 9</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p60897649">Specifies the advanced backup policy.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row33762549"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p50411912">dbRtPd</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p56833109">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p40079106">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p25182135">Specifies the password for user <strong id="en-us_topic_0032347785__b842352706154754">root</strong> of the database.</p>
<p id="en-us_topic_0032347785__p26487069">Valid value:</p>
<p id="en-us_topic_0032347785__p12429628144458">The value cannot be empty and should contain 8 to 32 characters, including uppercase and lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row48829755"><td class="cellrowborder" valign="top" width="29.520000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0032347785__p62896114">ha</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0032347785__p61420436">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.060000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0032347785__p8999435">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table622861661833">Table 10</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0032347785__p51028923">Specifies the HA configuration parameters, which are used when creating primary/standby DB instances.</p>
<div class="notice" id="en-us_topic_0032347785__note23027005161934"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="en-us_topic_0032347785__p5916456161934">RDS for Microsoft SQL Server does not support creating primary/standby DB instances and this parameter is not involved.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table228903751753"></a><a name="table228903751753"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table228903751753" frame="border" border="1" rules="all"><caption><b>Table 4 </b>instance field data structure description (creating a read replica)</caption><thead align="left"><tr id="en-us_topic_0032347785__row70524471753"><th align="left" class="cellrowborder" valign="top" width="29.330000000000002%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="en-us_topic_0032347785__p343772981753"><strong id="en-us_topic_0032347785__b446270986">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.6%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="en-us_topic_0032347785__p330977911753"><strong id="en-us_topic_0032347785__b130169355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.07%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="en-us_topic_0032347785__p636754041753"><strong id="en-us_topic_0032347785__b2139172576">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="en-us_topic_0032347785__p574340811753"><strong id="en-us_topic_0032347785__b1317973372">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row216489991753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0032347785__p87385011753">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0032347785__p367300201753">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0032347785__p223416761753">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0032347785__p181181003619">Specifies the DB instance name.</p>
<p id="en-us_topic_0032347785__p51611184">DB instances of the same type can have same names under the same tenant.</p>
<p id="en-us_topic_0032347785__p467369331753">Valid value:</p>
<p id="en-us_topic_0032347785__p24429179182049">The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row363844211753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0032347785__p614570251753">flavorRef</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0032347785__p119630961753">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0032347785__p294867401753">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0032347785__p396157731753">Specifies the specification ID (<strong id="en-us_topic_0032347785__b135018593298">flavors.id</strong> in the response message in section <a href="en-us_topic_0032347783.html">Obtaining All DB Instance Specifications</a>).</p>
<p id="en-us_topic_0032347785__p547610501753">Valid value:</p>
<p id="en-us_topic_0032347785__p230874081753">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="en-us_topic_0032347785__row260045131753"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0032347785__p259908001753">replicaOf</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0032347785__p248800801753">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0032347785__p20206171753">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0032347785__p294522581753">Specifies the read replica configuration parameter. It is used to create a read replica of a primary DB instance specified by <strong id="en-us_topic_0032347785__b84235270617137">replicaOf</strong></p>
<p id="en-us_topic_0032347785__p637437301753">Valid value:</p>
<p id="en-us_topic_0032347785__p368226591753">Only the primary DB instance ID is valid.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table64243102"></a><a name="table64243102"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table64243102" frame="border" border="1" rules="all"><caption><b>Table 5 </b>datastore field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row4043462"><th align="left" class="cellrowborder" valign="top" width="29.509999999999998%" id="mcps1.3.3.2.1.4.2.5.1.1"><p id="en-us_topic_0032347785__p59085005"><strong id="en-us_topic_0032347785__b561685455">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.3.2.1.4.2.5.1.2"><p id="en-us_topic_0032347785__p21156092"><strong id="en-us_topic_0032347785__b1601709326">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.07%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="en-us_topic_0032347785__p35921916"><strong id="en-us_topic_0032347785__b1579875191">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="en-us_topic_0032347785__p23994101"><strong id="en-us_topic_0032347785__b275391717">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row64473998"><td class="cellrowborder" valign="top" width="29.509999999999998%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="en-us_topic_0032347785__p55011311">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="en-us_topic_0032347785__p26731201">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="en-us_topic_0032347785__p17743659">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="en-us_topic_0032347785__p49175803141056">Specifies the DB engine. Currently, the following DB engines are supported:</p>
<ul id="en-us_topic_0032347785__ul924933143511"><li id="en-us_topic_0032347785__li1195974113511">MySQL</li><li id="en-us_topic_0032347785__li2014417783511">PostgreSQL</li><li id="en-us_topic_0032347785__li192495323520">SQLServer</li></ul>
</td>
</tr>
<tr id="en-us_topic_0032347785__row40466701"><td class="cellrowborder" valign="top" width="29.509999999999998%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="en-us_topic_0032347785__p56577386">version</p>
</td>
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="en-us_topic_0032347785__p19365543">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="en-us_topic_0032347785__p25105132">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="en-us_topic_0032347785__p20249826">Specifies the database version.</p>
<ul id="en-us_topic_0032347785__ul2128855618558"><li id="en-us_topic_0032347785__li532251018558">MySQL databases support 5.6, 5.7 and 8.0. Example value: 5.7</li><li id="en-us_topic_0032347785__li926104115396">PostgreSQL databases support 9.5, 9.6, 10, 11, 12, 13, 14 and 15. Example value: 9.6</li><li id="en-us_topic_0032347785__li10113118558">Microsoft SQL Server databases support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE. Example value: 2017_SE</li></ul>
<p id="en-us_topic_0032347785__p2139751518103">For details about supported database versions, see section <a href="en-us_topic_0032347782.html">Database Version Queries</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table10656503"></a><a name="table10656503"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table10656503" frame="border" border="1" rules="all"><caption><b>Table 6 </b>volume field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row5847780"><th align="left" class="cellrowborder" valign="top" width="29.32%" id="mcps1.3.3.2.1.5.2.5.1.1"><p id="en-us_topic_0032347785__p3908185"><strong id="en-us_topic_0032347785__b78191114">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.2.1.5.2.5.1.2"><p id="en-us_topic_0032347785__p48127554"><strong id="en-us_topic_0032347785__b1637062177">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.07%" id="mcps1.3.3.2.1.5.2.5.1.3"><p id="en-us_topic_0032347785__p6017800"><strong id="en-us_topic_0032347785__b1804815712">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.5.2.5.1.4"><p id="en-us_topic_0032347785__p17679762"><strong id="en-us_topic_0032347785__b1163885549">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row22774600"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="en-us_topic_0032347785__p32803348">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="en-us_topic_0032347785__p39825499">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="en-us_topic_0032347785__p4640007">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><p id="en-us_topic_0032347785__p40296320">Specifies the volume type.</p>
<p id="en-us_topic_0032347785__p27122565">Its value can be any of the following and is case-sensitive:</p>
<ul id="en-us_topic_0032347785__ul06211247141917"><li id="en-us_topic_0032347785__li5621447111914"><strong id="en-us_topic_0032347785__b49281844163118">COMMON</strong>: indicates the SATA type.</li><li id="en-us_topic_0032347785__li0621114751918"><strong id="en-us_topic_0032347785__b175251655173117">ULTRAHIGH</strong>: indicates the SSD type.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0032347785__row42343927"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="en-us_topic_0032347785__p7306053">size</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="en-us_topic_0032347785__p54919424">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.07%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="en-us_topic_0032347785__p19288335">Int</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><p id="en-us_topic_0032347785__p18851291">Specifies the volume size.</p>
<p id="en-us_topic_0032347785__p1878135135412">Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10.</p>
<p id="en-us_topic_0032347785__p8725181468"></p>
<div class="note" id="en-us_topic_0032347785__note02685513325"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347785__p385416153310">For read replicas, this parameter is invalid. The volume size is the same as that of the primary DB instance by default.</p>
<p id="en-us_topic_0032347785__p726165518328"></p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table2179128"></a><a name="table2179128"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table2179128" frame="border" border="1" rules="all"><caption><b>Table 7 </b>nics field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row28646034"><th align="left" class="cellrowborder" valign="top" width="29.09%" id="mcps1.3.3.2.1.6.2.5.1.1"><p id="en-us_topic_0032347785__p38627455"><strong id="en-us_topic_0032347785__b1779892109">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.98%" id="mcps1.3.3.2.1.6.2.5.1.2"><p id="en-us_topic_0032347785__p41816140"><strong id="en-us_topic_0032347785__b179863744">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.93%" id="mcps1.3.3.2.1.6.2.5.1.3"><p id="en-us_topic_0032347785__p31664161"><strong id="en-us_topic_0032347785__b1352251678">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.6.2.5.1.4"><p id="en-us_topic_0032347785__p14660263"><strong id="en-us_topic_0032347785__b1811461289">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row46630661"><td class="cellrowborder" valign="top" width="29.09%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="en-us_topic_0032347785__p18987236">subnetId</p>
</td>
<td class="cellrowborder" valign="top" width="18.98%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="en-us_topic_0032347785__p61571180">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.93%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="en-us_topic_0032347785__p21209668">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="en-us_topic_0032347785__p40261524">Specifies the network ID of the subnet obtained from VPC.</p>
<p id="en-us_topic_0032347785__p26809401">Valid value:</p>
<p id="en-us_topic_0032347785__p36848008144522">The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table4150710"></a><a name="table4150710"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table4150710" frame="border" border="1" rules="all"><caption><b>Table 8 </b>securityGroup field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row37742617"><th align="left" class="cellrowborder" valign="top" width="29.13%" id="mcps1.3.3.2.1.7.2.5.1.1"><p id="en-us_topic_0032347785__p37253141"><strong id="en-us_topic_0032347785__b1779777190">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.55%" id="mcps1.3.3.2.1.7.2.5.1.2"><p id="en-us_topic_0032347785__p64714441"><strong id="en-us_topic_0032347785__b1800196941">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.32%" id="mcps1.3.3.2.1.7.2.5.1.3"><p id="en-us_topic_0032347785__p7378398"><strong id="en-us_topic_0032347785__b511063084">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.7.2.5.1.4"><p id="en-us_topic_0032347785__p60779388"><strong id="en-us_topic_0032347785__b421240097">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row24183370"><td class="cellrowborder" valign="top" width="29.13%" headers="mcps1.3.3.2.1.7.2.5.1.1 "><p id="en-us_topic_0032347785__p12695920">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.3.2.1.7.2.5.1.2 "><p id="en-us_topic_0032347785__p21736599">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.32%" headers="mcps1.3.3.2.1.7.2.5.1.3 "><p id="en-us_topic_0032347785__p15834086">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.7.2.5.1.4 "><p id="en-us_topic_0032347785__p7492614">Valid value:</p>
<p id="en-us_topic_0032347785__p48836202144526">The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table49774232"></a><a name="table49774232"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table49774232" frame="border" border="1" rules="all"><caption><b>Table 9 </b>backupStrategy field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row48589216"><th align="left" class="cellrowborder" valign="top" width="29.330000000000002%" id="mcps1.3.3.2.1.8.2.5.1.1"><p id="en-us_topic_0032347785__p43412436"><strong id="en-us_topic_0032347785__b1067534665">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.16%" id="mcps1.3.3.2.1.8.2.5.1.2"><p id="en-us_topic_0032347785__p26746391"><strong id="en-us_topic_0032347785__b82261719">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.51%" id="mcps1.3.3.2.1.8.2.5.1.3"><p id="en-us_topic_0032347785__p18974100"><strong id="en-us_topic_0032347785__b1113332583">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.8.2.5.1.4"><p id="en-us_topic_0032347785__p60507121"><strong id="en-us_topic_0032347785__b855664940">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row13243689"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.8.2.5.1.1 "><p id="en-us_topic_0032347785__p66105898">startTime</p>
</td>
<td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.3.2.1.8.2.5.1.2 "><p id="en-us_topic_0032347785__p52977523">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.3.2.1.8.2.5.1.3 "><p id="en-us_topic_0032347785__p63321005">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.8.2.5.1.4 "><p id="en-us_topic_0032347785__p40942168155958">Specifies the backup start time that has been set.</p>
<p id="en-us_topic_0032347785__p57223682">Valid value:</p>
<p id="en-us_topic_0032347785__p29612155144531">The value cannot be empty. It must use the hh:mm:ss format and must be valid. The time is in the UTC format.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row41459726"><td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.3.2.1.8.2.5.1.1 "><p id="en-us_topic_0032347785__p2794650">keepDays</p>
</td>
<td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.3.2.1.8.2.5.1.2 "><p id="en-us_topic_0032347785__p25040094">No</p>
</td>
<td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.3.2.1.8.2.5.1.3 "><p id="en-us_topic_0032347785__p14981763">Int</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.8.2.5.1.4 "><p id="en-us_topic_0032347785__p30482871191015">Specifies the number of days to retain the generated backup files.</p>
<p id="en-us_topic_0032347785__p5563313">The value range is from 0 to 732. If this parameter is not specified or set to <strong id="en-us_topic_0032347785__b842352706112318">0</strong>, the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table622861661833"></a><a name="table622861661833"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table622861661833" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ha field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row141379661833"><th align="left" class="cellrowborder" valign="top" width="29.7%" id="mcps1.3.3.2.1.9.2.5.1.1"><p id="en-us_topic_0032347785__p43246301833"><strong id="en-us_topic_0032347785__b445308850">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.6%" id="mcps1.3.3.2.1.9.2.5.1.2"><p id="en-us_topic_0032347785__p147507341833"><strong id="en-us_topic_0032347785__b799218910">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.889999999999997%" id="mcps1.3.3.2.1.9.2.5.1.3"><p id="en-us_topic_0032347785__p539587821833"><strong id="en-us_topic_0032347785__b181171029">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.9.2.5.1.4"><p id="en-us_topic_0032347785__p85852311833"><strong id="en-us_topic_0032347785__b1606593092">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row243151121833"><td class="cellrowborder" valign="top" width="29.7%" headers="mcps1.3.3.2.1.9.2.5.1.1 "><p id="en-us_topic_0032347785__p233670901833">enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.9.2.5.1.2 "><p id="en-us_topic_0032347785__p136861651833">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.3.3.2.1.9.2.5.1.3 "><p id="en-us_topic_0032347785__p348375601833">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.9.2.5.1.4 "><p id="en-us_topic_0032347785__p32700831833">Specifies the HA configuration parameter.</p>
<p id="en-us_topic_0032347785__p294307511833">Valid value:</p>
<p id="en-us_topic_0032347785__p54112632144538">The value is <strong id="en-us_topic_0032347785__b842352706164817">true</strong> or <strong id="en-us_topic_0032347785__b842352706164826">false</strong>. The value <strong id="en-us_topic_0032347785__b842352706164830">true</strong> indicates creating primary/standby DB instances. The value <strong id="en-us_topic_0032347785__b765135452113640">false</strong> indicates creating a single DB instance.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row472905471833"><td class="cellrowborder" valign="top" width="29.7%" headers="mcps1.3.3.2.1.9.2.5.1.1 "><p id="en-us_topic_0032347785__p53291281833">replicationMode</p>
</td>
<td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.3.2.1.9.2.5.1.2 "><p id="en-us_topic_0032347785__p290062461833">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.3.3.2.1.9.2.5.1.3 "><p id="en-us_topic_0032347785__p6957001833">String</p>
</td>
<td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.9.2.5.1.4 "><p id="en-us_topic_0032347785__p6707901911827">Specifies the replication mode for the standby DB instance.</p>
<p id="en-us_topic_0032347785__p6684026611827">The value cannot be empty.</p>
<ul id="en-us_topic_0032347785__ul4535249811827"><li id="en-us_topic_0032347785__li551930011827">For MySQL, the value is <strong id="en-us_topic_0032347785__b842352706165650">async</strong> or <strong id="en-us_topic_0032347785__b842352706165654">semisync</strong>.</li><li id="en-us_topic_0032347785__li4967370611827">For PostgreSQL, the value is <strong id="en-us_topic_0032347785__b1658460331">async</strong> or <strong id="en-us_topic_0032347785__b246566107">sync</strong>.</li><li id="en-us_topic_0032347785__li139216391975">For Microsoft SQL Server, the value is <strong id="en-us_topic_0032347785__b1084866521183314">sync</strong>.</li></ul>
<div class="note" id="en-us_topic_0032347785__note6414722611827"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0032347785__ul4045412711827"><li id="en-us_topic_0032347785__li2854282711827"><strong id="en-us_topic_0032347785__b842352706105954">async</strong> indicates the asynchronous replication mode.</li><li id="en-us_topic_0032347785__li5555885511827"><strong id="en-us_topic_0032347785__b842352706164020">semisync</strong> indicates the semi-synchronous replication mode.</li><li id="en-us_topic_0032347785__li3026765211827"><strong id="en-us_topic_0032347785__b13384211081105">sync</strong> indicates the synchronous replication mode.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0032347785__ul10190321"><li id="en-us_topic_0032347785__li24604028">Request example<p id="en-us_topic_0032347785__p20109663"><a name="en-us_topic_0032347785__li24604028"></a><a name="li24604028"></a>Creating a single DB instance:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock3265333317938">{
"instance": {
"name": "trove-instance-rep2",
"datastore": {
"type": "MySQL",
"version": "5.7"
},
"flavorRef": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4",
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"region": "eu-de",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"dbPort": 3306,
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
},
"dbRtPd": "Test@123"
}
}</pre>
<p id="en-us_topic_0032347785__p33599791">Creating primary/standby DB instances:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock281841915725">{
"instance": {
"name": "trove-instance-ha",
"datastore": {
"type": "MySQL",
"version": "5.7"
},
"flavorRef": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4",
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"region": "eu-de",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"dbPort": 3306,
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
},
"dbRtPd": "Test@123",
"ha": {
"enable": true,
"replicationMode": "async"
}
}
}</pre>
<p id="en-us_topic_0032347785__p14734188">Creating a read replica:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock22965072171041">{
"instance": {
"name": "trove-instance-replica2",
"flavorRef": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4",
"replicaOf": "373af3b8-8f44-44f6-bb90-85f1c32c50d6"
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0032347785__section36749739"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0032347785__ul48268995"><li id="en-us_topic_0032347785__li31767774">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table17474517" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347785__row16146366"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0032347785__p32787233"><strong id="en-us_topic_0032347785__b1135864208">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.15%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0032347785__p38520254"><strong id="en-us_topic_0032347785__b1385659541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.52%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0032347785__p33132859"><strong id="en-us_topic_0032347785__b2056931038">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row66515904"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347785__p19079158">instance</p>
</td>
<td class="cellrowborder" valign="top" width="33.15%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347785__p1907972">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table27245651">Table 12</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.52%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347785__p48735027">Indicates the DB instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table27245651"></a><a name="table27245651"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table27245651" frame="border" border="1" rules="all"><caption><b>Table 12 </b>instance field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row47625437"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0032347785__p32455223"><strong id="en-us_topic_0032347785__b1910676470">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0032347785__p11627434"><strong id="en-us_topic_0032347785__b1821282506">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0032347785__p2298077"><strong id="en-us_topic_0032347785__b1594643084">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row51926520"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p45298596">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p45307656">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p7417132564016">Indicates the primary node ID of the DB instance.</p>
<div class="note" id="en-us_topic_0032347785__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347785__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032347785__row56907078"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p46070597">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p40730901">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p10868702">Indicates the DB instance status. The value is <span class="parmvalue" id="en-us_topic_0032347785__parmvalue2029132012164130"><b>BUILD</b></span>.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row30709455"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p4437887">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p23924539">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p58839532">Indicates the created DB instance name.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row59793748"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p11455439">created</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p55475379">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p64320678">Indicates the creation time in the "yyyy-mm-dd Thh:mm:ssZ" format.</p>
<p id="en-us_topic_0032347785__p6642150175824"><strong id="en-us_topic_0032347785__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="en-us_topic_0032347785__b842352706153833">Z</strong> indicates the time zone offset. </p>
<div class="note" id="en-us_topic_0032347785__note5126817175844"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347785__p46141354175844">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032347785__row42592467"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p27437792">hostname</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p7868661">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p33381819">Indicates the DB instance connection address. It is a blank string.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row32000920"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p41937705">type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p41510976">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p373123731890">Indicates the DB instance type, which can be <strong id="en-us_topic_0032347785__b84235270617352">master</strong> or <strong id="en-us_topic_0032347785__b84235270617355">readreplica</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row32924936175949"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p27888975175949">region</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p44414535175949">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p40807567175949">Same as the request parameter.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row62512728"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p30366184">updated</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p43741849">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p53428882">Indicates the updated time, which is the same as <strong id="en-us_topic_0032347785__b8423527061176">created</strong>.</p>
<div class="note" id="en-us_topic_0032347785__note542057061864"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347785__p180893121864">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032347785__row11097898"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p26514531">availabilityZone</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p193401">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p15665491">Same as the request parameter.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row785288110273"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p356707210273">vpc</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p2049740210273">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p4967688510273">Same as the request parameter.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row6771693"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p11636265">nics</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p3013405">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table41614513165139">Table 13</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p474926017024">Indicates the nics information.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row49289224"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p33004241">securityGroup</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p56097870">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table255609017350">Table 14</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p47633640">Indicates the security group information.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row26049579"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p29641146">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p52122650">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table223791861780">Table 15</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p61185139">Indicates the DB instance specifications.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row13795340"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p43680716">volume</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p48477080">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p34329433">Same as the request parameter.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row9414870143634"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p59587820143645">dbPort</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p61884126143645">Int</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p46558333143645">Same as the request parameter.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row40529449"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p482489891182">dataStoreInfo</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p245175991182">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p573542861182">Indicates the database information.</p>
<div class="note" id="en-us_topic_0032347785__note668950831190"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347785__p651848381190">The value is <strong id="en-us_topic_0032347785__b842352706141412">null</strong> when the DB instance is being created. After the instance is created, the value is not <strong id="en-us_topic_0032347785__b889385641141721">null</strong>.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032347785__row2353067711815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p6520993211819">extendparam</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p4751311611819">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table3492062317170">Table 16</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p694709518538">Indicates the returned <strong id="en-us_topic_0032347785__b842352706113519">extendparam</strong> key-value pair.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row56982912"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p186985881187">backupStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p381906881187">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table18267654155052">Table 18</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p64380241187">Indicates the backup policy.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row3430840811031"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p5489247911055">slaveId</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p1710580811055">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p4339317311055">It is returned only when you create primary/standby DB instances.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row810597210337"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p32354858103312">ha</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p3497827103312">Dictionary data structure. For details, see <a href="#en-us_topic_0032347785__table16318932171721">Table 19</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p14888569103312">Indicates the primary/standby DB instance information. It is returned only when you create primary/standby DB instances.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row19867487"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347785__p65762630">replica_of</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347785__p25172842">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347785__p25734322">Same as the request parameter. It is returned only when you create a read replica.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table41614513165139"></a><a name="table41614513165139"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table41614513165139" frame="border" border="1" rules="all"><caption><b>Table 13 </b>nics field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row61695746165139"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0032347785__p30976535165713"><strong id="en-us_topic_0032347785__b84235270691445">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0032347785__p26071408165713"><strong id="en-us_topic_0032347785__b1103420156">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0032347785__p31409338165713"><strong id="en-us_topic_0032347785__b1476048746">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row50187499165139"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0032347785__p38655590165139">subnetId</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0032347785__p44095090165139">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0032347785__p14932534165139">Indicates the network ID of the subnet.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table255609017350"></a><a name="table255609017350"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table255609017350" frame="border" border="1" rules="all"><caption><b>Table 14 </b>securityGroup field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row6077622417350"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="en-us_topic_0032347785__p2392711017350"><strong id="en-us_topic_0032347785__b2096455507">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="en-us_topic_0032347785__p5904772817350"><strong id="en-us_topic_0032347785__b1431903871">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="en-us_topic_0032347785__p1813664617350"><strong id="en-us_topic_0032347785__b2090291114">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row5978225817350"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0032347785__p1052469717350">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0032347785__p4719414917350">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0032347785__p6462975817350">Indicates the security group ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table223791861780"></a><a name="table223791861780"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table223791861780" frame="border" border="1" rules="all"><caption><b>Table 15 </b>flavor field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row477223291780"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="en-us_topic_0032347785__p403034631780"><strong id="en-us_topic_0032347785__b1543007270">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="en-us_topic_0032347785__p433550451780"><strong id="en-us_topic_0032347785__b819202093">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="en-us_topic_0032347785__p220977231780"><strong id="en-us_topic_0032347785__b1107720648">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row450851381780"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0032347785__p280175531780">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0032347785__p548293451780">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0032347785__p119919781780">Indicates the specification ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table3492062317170"></a><a name="table3492062317170"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table3492062317170" frame="border" border="1" rules="all"><caption><b>Table 16 </b>extendparam field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row3304075417170"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="en-us_topic_0032347785__p5905541217170"><strong id="en-us_topic_0032347785__b96307093">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="en-us_topic_0032347785__p1875905417170"><strong id="en-us_topic_0032347785__b512168666">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="en-us_topic_0032347785__p4308842517170"><strong id="en-us_topic_0032347785__b2141051311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row50154917170"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="en-us_topic_0032347785__p4062547217170">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="en-us_topic_0032347785__p19575195171837">List data structure. For details, see <a href="#en-us_topic_0032347785__table66691786171712">Table 17</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="en-us_topic_0032347785__p3219143118355">Indicates the returned <strong id="en-us_topic_0032347785__b842352706113940">jobs</strong> parameter information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table66691786171712"></a><a name="table66691786171712"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table66691786171712" frame="border" border="1" rules="all"><caption><b>Table 17 </b>jobs field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row8628012171712"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="en-us_topic_0032347785__p27780390171712"><strong id="en-us_topic_0032347785__b1965093237">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="en-us_topic_0032347785__p35619108171712"><strong id="en-us_topic_0032347785__b747775651">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="en-us_topic_0032347785__p66575503171712"><strong id="en-us_topic_0032347785__b1014433560">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row23906638171712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0032347785__p57389514171712">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0032347785__p66545816171941">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0032347785__p6182355918413">Indicates the task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table18267654155052"></a><a name="table18267654155052"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table18267654155052" frame="border" border="1" rules="all"><caption><b>Table 18 </b>backupStrategy field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row10891999155052"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="en-us_topic_0032347785__p9836690155052"><strong id="en-us_topic_0032347785__b1551871547">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="en-us_topic_0032347785__p58574463155052"><strong id="en-us_topic_0032347785__b2032987277">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="en-us_topic_0032347785__p46911052155052"><strong id="en-us_topic_0032347785__b1934094364">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row41698849155052"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0032347785__p22163623155052">startTime</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0032347785__p50423045155052">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0032347785__p60186704155531">Indicates the backup start time that has been set. The backup task will be triggered within one hour after the backup start time.</p>
</td>
</tr>
<tr id="en-us_topic_0032347785__row21085930155133"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0032347785__p30238783155133"><span id="en-us_topic_0032347785__ph36692851155324">keepDays</span></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0032347785__p33422344155133"><span id="en-us_topic_0032347785__ph40947182155522">Int</span></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0032347785__p23098270155542">Indicates the number of days to retain the generated backup files.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032347785__table16318932171721"></a><a name="table16318932171721"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347785__table16318932171721" frame="border" border="1" rules="all"><caption><b>Table 19 </b>ha field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347785__row4195882171721"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.9.2.4.1.1"><p id="en-us_topic_0032347785__p4322179171721"><strong id="en-us_topic_0032347785__b1664211329">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.9.2.4.1.2"><p id="en-us_topic_0032347785__p14552188171721"><strong id="en-us_topic_0032347785__b1773223076">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.9.2.4.1.3"><p id="en-us_topic_0032347785__p37876541171721"><strong id="en-us_topic_0032347785__b1937211688">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032347785__row48100975171721"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.9.2.4.1.1 "><p id="en-us_topic_0032347785__p3864889171721">replicationMode</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.9.2.4.1.2 "><p id="en-us_topic_0032347785__p44620612171721">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.9.2.4.1.3 "><p id="en-us_topic_0032347785__p57499832171721">Indicates the replication mode for the standby DB instance. Same as the request parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0032347785__ul50009058"><li id="en-us_topic_0032347785__li47428342">Response example<p id="en-us_topic_0032347785__p24201902"><a name="en-us_topic_0032347785__li47428342"></a><a name="li47428342"></a>Creating a single DB instance:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock19377062171138">{
"instance": {
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "",
"hostname": "",
"type": "master",
"region": "eu-de",
"updated": "",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"dbPort": 3306,
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dataStoreInfo": null,
"extendparam": {
"jobs": [
{
"id": "ff8080815564ddf5015564f64a560024"
}
]
},
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
}
}
}</pre>
<p id="en-us_topic_0032347785__p51347269">Creating primary/standby DB instances:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock58372239171218">{
"instance": {
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "",
"hostname": "",
"type": "master",
"region": "eu-de",
"updated": "",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dbPort": 3306,
"dataStoreInfo": null,
"extendparam": {
"jobs": [
{
"id": "ff8080815564ddf5015564f64a560024"
},
{
"id": "ae3081675564ddf5357564f64a560025"
}
]
},
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
},
"slaveId": "9405d8b8-a87d-4531-bd3a-e504c8434281",
"ha": {
"replicationMode": "async"
}
}
}</pre>
<p id="en-us_topic_0032347785__p28167350">Creating a read replica:</p>
<pre class="codeblock" id="en-us_topic_0032347785__codeblock5637539517131">{
"instance": {
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "",
"hostname": "",
"type": "readreplica",
"region": "eu-de",
"updated": "",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dbPort": 3306,
"dataStoreInfo": null,
"extendparam": {
"jobs": [
{
"id": "ff8080815564ddf5015564f64a560024"
}
]
},
"replica_of": "252f11f1-2912-4c06-be55-1999bde659c5"
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0032347785__section62312200"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0032347785__p29415884">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0016.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink