forked from docs/doc-exports
Ru, Li Yi
9457035d64
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>
1054 lines
89 KiB
HTML
1054 lines
89 KiB
HTML
<a name="rds_01_0002"></a><a name="rds_01_0002"></a>
|
|
|
|
<h1 class="topictitle1">Creating a DB Instance</h1>
|
|
<div id="body1535613843473"><div class="section" id="rds_01_0002__section4284989"><h4 class="sectiontitle">Function</h4><p id="rds_01_0002__p28332047">This API is used to create a single RDS DB instance, primary/standby DB instances, or a read replica.</p>
|
|
<ul id="rds_01_0002__ul12259155218373"><li id="rds_01_0002__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_01_0002__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0002__section38564907"><h4 class="sectiontitle">URI</h4><ul id="rds_01_0002__ul13194498"><li id="rds_01_0002__li51641620">URI format<p id="rds_01_0002__p62121397"><a name="rds_01_0002__li51641620"></a><a name="li51641620"></a>POST https://{<em id="rds_01_0002__i1958383021511">Endpoint</em>}/v3/{project_id}/instances</p>
|
|
</li><li id="rds_01_0002__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0002__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_01_0002__p10809459"><strong id="rds_01_0002__b13612184114314">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_01_0002__p3150961"><strong id="rds_01_0002__b7976204244310">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_01_0002__p53901255"><strong id="rds_01_0002__b874064312434">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_01_0002__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_01_0002__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_01_0002__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_01_0002__p131433595402">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0002__section11539844"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description (creating single and primary/standby DB instances)</caption><thead align="left"><tr id="rds_01_0002__row61525259"><th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.3.2.2.5.1.1"><p id="rds_01_0002__p17490046"><strong id="rds_01_0002__b193256496458">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.65346534653465%" id="mcps1.3.3.2.2.5.1.2"><p id="rds_01_0002__p7407659"><strong id="rds_01_0002__b299655164516">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.2.5.1.3"><p id="rds_01_0002__p63149496"><strong id="rds_01_0002__b1103195634512">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.683168316831683%" id="mcps1.3.3.2.2.5.1.4"><p id="rds_01_0002__p14835533"><strong id="rds_01_0002__b45319574450">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row60827539"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p28083633">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p42890904">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p23411412333">Specifies the DB instance name.</p>
|
|
<p id="rds_01_0002__p51611184">DB instances of the same type can have same names under the same tenant.</p>
|
|
<p id="rds_01_0002__p61847473">The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row56760689"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p34213098">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p19797588">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__a9a9492e05cb648e885d1e747a339d04d">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p58520811">Specifies the database information.</p>
|
|
<p id="rds_01_0002__p6426115842318">For details, see <a href="#rds_01_0002__table64243102">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row153106284519"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p1449010592056">ha</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p1249795916511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p44233713193">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p1851455914518">Specifies the HA configuration parameters, which are used when creating primary/standby DB instances.</p>
|
|
<p id="rds_01_0002__p116241910162412">For details, see <a href="#rds_01_0002__table13260175614296">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row933354567"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p5334544617">configuration_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p93315541168">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p173313549619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p53312541067">Specifies the parameter template ID.</p>
|
|
<p id="rds_01_0002__p91885306228">For details, see <span class="parmname" id="rds_01_0002__parmname11831112133013"><b>id</b></span> in <a href="rds_09_0301.html#rds_09_0301__table1324110018258">Table 3</a> in section <a href="rds_09_0301.html">Obtaining a Parameter Template List</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row59881004135"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p3913191019136">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p69131102134">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p6913210191313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p19914101012135">Specifies the database port information.</p>
|
|
<ul id="rds_01_0002__ul10438123672912"><li id="rds_01_0002__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="rds_01_0002__li10438636192916">The PostgreSQL database port ranges from 2100 to 9500.</li><li id="rds_01_0002__li2438203662918">The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985). </li></ul>
|
|
<p id="rds_01_0002__p6601319181417">If this parameter is not set, the default value is as follows:</p>
|
|
<ul id="rds_01_0002__ul1696512278148"><li id="rds_01_0002__li25818392140">For MySQL, the default value is <strong id="rds_01_0002__b1829614472613">3306</strong>.</li><li id="rds_01_0002__li93271730121413">For PostgreSQL, the default value is <strong id="rds_01_0002__b13817121574">5432</strong>.</li><li id="rds_01_0002__li12965162714143">For Microsoft SQL Server, the default value is <strong id="rds_01_0002__b1633152143014">1433</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row5642202221319"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p75222324139">password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p6522163210139">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p1352217328132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p252314328139">Specifies the database password.</p>
|
|
<p id="rds_01_0002__p26487069">Valid value:</p>
|
|
<p id="rds_01_0002__p644584115526">A database password must be 8 to 32 characters long and contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.</p>
|
|
<p id="rds_01_0002__p1269682315132">Different DB engines support different special characters.</p>
|
|
<ul id="rds_01_0002__ul15802015165417"><li id="rds_01_0002__li158031015125410">RDS for MySQL: ~!@#$%^*-_=+?,()&</li><li id="rds_01_0002__li1966311114324">RDS for PostgreSQL: ~!@#$%^*-_=+?,</li><li id="rds_01_0002__li11581772337">RDS for SQL Server: ~!@#$%^*-_+?,</li></ul>
|
|
<p id="rds_01_0002__p12429628144458">You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking. If the password you provide is regarded as a weak password by the system, you will be prompted to enter a stronger password.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1531134871717"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p169876381815">backup_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p9987103141817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p13697181131913">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p14803115432218">Specifies the advanced backup policy.</p>
|
|
<p id="rds_01_0002__p16503153252414">For details, see <a href="#rds_01_0002__table0863181193416">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1842179141917"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p76971418121913">disk_encryption_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p206971718181915">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p14699618121914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p1669991812194">Specifies the key ID for disk encryption. The default value is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row42565233"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p25231885">flavor_ref</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p30516772">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p55939488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p11524913121019">Specifies the specification code. The value cannot be empty.</p>
|
|
<p id="rds_01_0002__p1778193619122">For details, see <span class="parmname" id="rds_01_0002__parmname6175172718302"><b>spec_code</b></span> in <a href="rds_06_0002.html#rds_06_0002__table1336414511696">Table 3</a> in section <a href="rds_06_0002.html">Querying Database Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row49370368"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p39576862">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p51609257">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p1811431418199">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p61513540">Specifies the volume information.</p>
|
|
<p id="rds_01_0002__p12360550192412">For details, see <a href="#rds_01_0002__table10656503">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row16540805"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p64736823">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p9191297">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p6297612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p40344576">Specifies the region ID.</p>
|
|
<p id="rds_01_0002__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="rds_01_0002__row9307971"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p15748167">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p533144">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p43184669">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p8297278">Specifies the AZ ID. If the DB instance is not a single instance, you need to specify an AZ for each node of the instance and separate the AZs with commas (,). For details, see the example.</p>
|
|
<p id="rds_01_0002__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="rds_01_0002__row51313205"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p62728917">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p47877526">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p52874399">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p1593595153419">Specifies the VPC ID. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul250415512347"><li id="rds_01_0002__li67651171359">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="rds_01_0002__li948317405377">Method 2: See the "Querying VPCs" section in the <em id="rds_01_0002__i842352697165629">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row15861880"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p9743886">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p51057338">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p42003681">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p512371711393">Specifies the network ID. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul9152102763919"><li id="rds_01_0002__li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="rds_01_0002__b4101174416409">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="rds_01_0002__li073418475515">Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in <em id="rds_01_0002__i110819661">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row7203203711117"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p192741199315">data_vip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p1127491918312">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p202746191539">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p52748190315">Specifies the private IP address of a DB instance. You can use the following methods to obtain the private IP address:</p>
|
|
<ul id="rds_01_0002__ul24803102271"><li id="rds_01_0002__li248011072717">Method 1: Log in to VPC console and click the target subnet on the <strong id="rds_01_0002__b39961957205714">Subnets</strong> page. You can view the subnet CIDR block on the displayed page.</li><li id="rds_01_0002__li881594742916">Method 2: See the "Querying Subnets" section under "APIs" in the <em id="rds_01_0002__i1087062205815">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row66008059"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p45052529">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p25376232">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p42208903">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p193681417164213">Specifies the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul16404122194211"><li id="rds_01_0002__li94054222421">Method 1: Log in to VPC console. Choose <strong id="rds_01_0002__b1913676122">Access Control</strong> > <strong id="rds_01_0002__b789502111219">Security Groups</strong> in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.</li><li id="rds_01_0002__li17405132214423">Method 2: See the "Querying Security Groups" section in the <em id="rds_01_0002__i2369584559">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row8447315691"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p12016301915">charge_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p18093019918">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p1813161911919">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p180153019913">Specifies the billing information, which is pay-per-use. By default, pay-per-use is used.</p>
|
|
<p id="rds_01_0002__p195191056102519">For details, see <a href="#rds_01_0002__table992615211258">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row2380157153917"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p1315210541211">unchangeable_param</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p1152155415213">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p1415218549219">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p815265416216">Specifies the list of unchangeable parameters. The unchangeable parameters need to be specified before database initialization and cannot be modified after being specified.</p>
|
|
<p id="rds_01_0002__p587291892414">For details, see <a href="#rds_01_0002__table951671018275">Table 9</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row618716165717"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_01_0002__p16101816165717">collation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_01_0002__p1410161617570">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_01_0002__p91017162576">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.683168316831683%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_01_0002__p410161655710">This parameter applies only to Microsoft SQL Server DB instances.</p>
|
|
<p id="rds_01_0002__p7113165579">Value range: character sets queried in <a href="rds_05_0010.html">Querying the Available SQL Server Character Set</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table16591198151210" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter for Replica creation (For Microsoft SQL Server, Only 2022_EE, 2019_EE and 2017_EE support the creation of read replicas and do not support the creation of single DB instances.)</caption><thead align="left"><tr id="rds_01_0002__row1663514861214"><th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.3.3.2.5.1.1"><p id="rds_01_0002__p18645086122"><strong id="rds_01_0002__b132301532184914">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.71287128712871%" id="mcps1.3.3.3.2.5.1.2"><p id="rds_01_0002__p206550811210"><strong id="rds_01_0002__b4232143444910">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.3.2.5.1.3"><p id="rds_01_0002__p2665684124"><strong id="rds_01_0002__b351811352492">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35.64356435643564%" id="mcps1.3.3.3.2.5.1.4"><p id="rds_01_0002__p1967819813127"><strong id="rds_01_0002__b455383664913">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row1169268141212"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p18702148111210">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p9711087123">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p127211481129">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p20251134153419">Specifies the DB instance name.</p>
|
|
<p id="rds_01_0002__p122543423410">DB instances of the same type can have same names under the same tenant.</p>
|
|
<p id="rds_01_0002__p9739986124">The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row179663811216"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p1297510801214">replica_of_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p4984168121215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p1727498128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p1136159181211">Specifies the DB instance ID, which is used to create a read replica.</p>
|
|
<p id="rds_01_0002__p48851020185819">For details, see <span class="parmname" id="rds_01_0002__parmname242413171108"><b>id</b></span> in <a href="rds_01_0004.html#rds_01_0004__table2058713718267">Table 3</a> in section <a href="rds_01_0004.html">Querying Details About DB Instances</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1713809131212"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p101485981219">disk_encryption_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p615549111212">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p151661892126">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p1918039171210">Specifies the key ID for disk encryption. The default value is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row219811901216"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p920529201219">flavor_ref</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p4214192128">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p17227199201212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p5402027141614">Specifies the specification code. The value cannot be empty.</p>
|
|
<p id="rds_01_0002__p1645132714167">For details, see <span class="parmname" id="rds_01_0002__parmname228712136432"><b>spec_code</b></span> in <a href="rds_06_0002.html#rds_06_0002__table1336414511696">Table 3</a> in section <a href="rds_06_0002.html">Querying Database Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1325015961210"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p132588914128">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p5266498128">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p4982172211916">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p92926915126">Specifies the volume information.</p>
|
|
<p id="rds_01_0002__p1253782122620">For details, see <a href="#rds_01_0002__table10656503">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row152988911120"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p6307990122">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p33171895128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p93263961213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p1833589161210">Specifies the region ID. Currently, read replicas can be created only in the same region as that of the primary DB instance.</p>
|
|
<p id="rds_01_0002__p1034210971218">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="rds_01_0002__row154028915126"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p1141010961213">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p3420291128">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p1742813913128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p743712961216">Specifies the AZ ID.</p>
|
|
<p id="rds_01_0002__p04480991212">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="rds_01_0002__row77777191106"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_01_0002__p13402152714108">charge_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.71287128712871%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_01_0002__p134021276106">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_01_0002__p44771426201913">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.64356435643564%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_01_0002__p19402192710107">Specifies the billing information, which is pay-per-use. By default, pay-per-use is used.</p>
|
|
<p id="rds_01_0002__p545918325262">For details, see <a href="#rds_01_0002__table992615211258">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table64243102"></a><a name="table64243102"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table64243102" frame="border" border="1" rules="all"><caption><b>Table 4 </b>datastore field data structure description</caption><thead align="left"><tr id="rds_01_0002__row4043462"><th align="left" class="cellrowborder" valign="top" width="19.49%" id="mcps1.3.3.4.2.5.1.1"><p id="rds_01_0002__p59085005"><strong id="rds_01_0002__b7454018185715">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.21%" id="mcps1.3.3.4.2.5.1.2"><p id="rds_01_0002__p21156092"><strong id="rds_01_0002__b127117321005">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.25%" id="mcps1.3.3.4.2.5.1.3"><p id="rds_01_0002__p35921916"><strong id="rds_01_0002__b139516339019">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.049999999999997%" id="mcps1.3.3.4.2.5.1.4"><p id="rds_01_0002__p23994101"><strong id="rds_01_0002__b8978123412012">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row64473998"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rds_01_0002__p55011311">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rds_01_0002__p26731201">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rds_01_0002__p17743659">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.049999999999997%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rds_01_0002__p49175803141056">Specifies the DB engine. Value:</p>
|
|
<ul id="rds_01_0002__ul924933143511"><li id="rds_01_0002__li1195974113511">MySQL</li><li id="rds_01_0002__li2014417783511">PostgreSQL</li><li id="rds_01_0002__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row40466701"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rds_01_0002__p56577386">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rds_01_0002__p19365543">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rds_01_0002__p25105132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.049999999999997%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rds_01_0002__p20249826">Specifies the database version.</p>
|
|
<ul id="rds_01_0002__ul2128855618558"><li id="rds_01_0002__li532251018558">MySQL databases support 5.6, 5.7, and 8.0. Example value: 5.7 </li><li id="rds_01_0002__li134407134561">PostgreSQL databases support 9.5, 9.6, 10, 11, 12, 13, 14 and 15. Example value: 9.6</li><li id="rds_01_0002__li7303143151411">Microsoft SQL Server databases only support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE. Example value: 2017_SE</li></ul>
|
|
<p id="rds_01_0002__p2139751518103">For details about supported database versions, see section <a href="rds_06_0001.html">Querying Version Information About a DB Engine</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table13260175614296"></a><a name="table13260175614296"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table13260175614296" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ha field data structure description</caption><thead align="left"><tr id="rds_01_0002__row430415632917"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="rds_01_0002__p83131256172915"><strong id="rds_01_0002__b335119141821">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.3.5.2.5.1.2"><p id="rds_01_0002__p1532014560298"><strong id="rds_01_0002__b157567152024">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.5.2.5.1.3"><p id="rds_01_0002__p83297567293"><strong id="rds_01_0002__b07661616521">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35%" id="mcps1.3.3.5.2.5.1.4"><p id="rds_01_0002__p734219563293"><strong id="rds_01_0002__b192774181121">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row173521956122913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="rds_01_0002__p123571256172914">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.5.2.5.1.2 "><p id="rds_01_0002__p336525662915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.5.2.5.1.3 "><p id="rds_01_0002__p15376756162917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.5.2.5.1.4 "><p id="rds_01_0002__p16181542163018">Specifies the primary/standby or cluster instance type. The value is <strong id="rds_01_0002__b3498224125">Ha</strong> (case-insensitive).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row840515672916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="rds_01_0002__p92151105323">replication_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.5.2.5.1.2 "><p id="rds_01_0002__p62151809326">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.5.2.5.1.3 "><p id="rds_01_0002__p1721540173210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.5.2.5.1.4 "><p id="rds_01_0002__p15585263415">Specifies the replication mode for the standby DB instance.</p>
|
|
<p id="rds_01_0002__p121155213343">Value:</p>
|
|
<ul id="rds_01_0002__ul120105263413"><li id="rds_01_0002__li183417529344">For MySQL, the value is <strong id="rds_01_0002__b842352706165650_1">async</strong> or <strong id="rds_01_0002__b842352706165654_1">semisync</strong>.</li><li id="rds_01_0002__li104755213411">For PostgreSQL, the value is <strong id="rds_01_0002__b842352706165650_5">async</strong> or <strong id="rds_01_0002__b842352706165654_5">sync</strong>.</li><li id="rds_01_0002__li1156155243418">For Microsoft SQL Server, the value is <strong id="rds_01_0002__b1084866521183314">sync</strong>.</li></ul>
|
|
<div class="note" id="rds_01_0002__note17075210348"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="rds_01_0002__ul9881252203415"><li id="rds_01_0002__li9951452133414"><strong id="rds_01_0002__b842352706105954">async</strong> indicates the asynchronous replication mode.</li><li id="rds_01_0002__li163121013819"><strong id="rds_01_0002__b842352706164020">semisync</strong> indicates the semi-synchronous replication mode.</li><li id="rds_01_0002__li191090527341"><strong id="rds_01_0002__b13384211081105">sync</strong> indicates the synchronous replication mode.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table0863181193416"></a><a name="table0863181193416"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table0863181193416" frame="border" border="1" rules="all"><caption><b>Table 6 </b>backupStrategy field data structure description</caption><thead align="left"><tr id="rds_01_0002__row49079123417"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.6.2.5.1.1"><p id="rds_01_0002__p491419118346"><strong id="rds_01_0002__b1519442321112">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.3.6.2.5.1.2"><p id="rds_01_0002__p1921131193411"><strong id="rds_01_0002__b89021624111113">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.6.2.5.1.3"><p id="rds_01_0002__p1293171203411"><strong id="rds_01_0002__b1010742615116">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35%" id="mcps1.3.3.6.2.5.1.4"><p id="rds_01_0002__p17939718349"><strong id="rds_01_0002__b3857828121111">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row1094610120345"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.6.2.5.1.1 "><p id="rds_01_0002__p1295681153413">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.3.6.2.5.1.2 "><p id="rds_01_0002__p119619110347">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.6.2.5.1.3 "><p id="rds_01_0002__p5970201183417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.6.2.5.1.4 "><p id="rds_01_0002__p8983181183415">Specifies the backup time window. Automated backups will be triggered during the backup time window.</p>
|
|
<p id="rds_01_0002__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="rds_01_0002__ul73551635192814"><li id="rds_01_0002__li13765154012810">The <strong id="rds_01_0002__b5530258153011">HH</strong> value must be 1 greater than the <strong id="rds_01_0002__b2053210587304">hh</strong> value.</li><li id="rds_01_0002__li1510111915298">The values of <strong id="rds_01_0002__b980810043118">mm</strong> and <strong id="rds_01_0002__b48083010310">MM</strong> must be the same and must be set to any of the following: <strong id="rds_01_0002__b780814063112">00</strong>, <strong id="rds_01_0002__b1580890143110">15</strong>, <strong id="rds_01_0002__b2809180133112">30</strong>, or <strong id="rds_01_0002__b1780918016317">45</strong>.</li></ul>
|
|
<p id="rds_01_0002__p59342194324">Example value:</p>
|
|
<ul id="rds_01_0002__ul1210322243217"><li id="rds_01_0002__li17296724143217">08:15-09:15</li><li id="rds_01_0002__li18103722163216">23:00-00:00</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1699610173414"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.6.2.5.1.1 "><p id="rds_01_0002__p677216342">keep_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.3.6.2.5.1.2 "><p id="rds_01_0002__p2171624347">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.6.2.5.1.3 "><p id="rds_01_0002__p125424341">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.6.2.5.1.4 "><p id="rds_01_0002__p13613273417">Specifies the retention days for specific backup files.</p>
|
|
<p id="rds_01_0002__p7391722345">The value range is from 0 to 732. If this parameter is not specified or set to <strong id="rds_01_0002__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>
|
|
<div class="notice" id="rds_01_0002__note861516536349"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="rds_01_0002__p1558917683213">Primary/standby DB instances and Cluster DB instances of Microsoft SQL Server do not support disabling the automated backup policy.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table10656503"></a><a name="table10656503"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table10656503" frame="border" border="1" rules="all"><caption><b>Table 7 </b>volume field data structure description</caption><thead align="left"><tr id="rds_01_0002__row5847780"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.7.2.5.1.1"><p id="rds_01_0002__p3908185"><strong id="rds_01_0002__b856633513152">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.3.7.2.5.1.2"><p id="rds_01_0002__p48127554"><strong id="rds_01_0002__b20635173612152">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.7.2.5.1.3"><p id="rds_01_0002__p6017800"><strong id="rds_01_0002__b1280583810151">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35%" id="mcps1.3.3.7.2.5.1.4"><p id="rds_01_0002__p17679762"><strong id="rds_01_0002__b10752439191511">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row22774600"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.7.2.5.1.1 "><p id="rds_01_0002__p32803348">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.7.2.5.1.2 "><p id="rds_01_0002__p39825499">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.7.2.5.1.3 "><p id="rds_01_0002__p4640007">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.7.2.5.1.4 "><p id="rds_01_0002__p40296320">Specifies the volume type.</p>
|
|
<p id="rds_01_0002__p27122565">Its value can be any of the following and is case-sensitive:</p>
|
|
<ul id="rds_01_0002__ul7711857141311"><li id="rds_01_0002__li17711857191312"><strong id="rds_01_0002__b175811447151011">COMMON</strong>: SATA storage.</li><li id="rds_01_0002__li1671115572136"><strong id="rds_01_0002__b692704062510">ULTRAHIGH</strong>: ultra-high I/O storage.</li><li id="rds_01_0002__li882154133612"><strong id="rds_01_0002__b962134413123">CLOUDSSD</strong>: cloud SSD storage.</li><li id="rds_01_0002__li1186817447711"><strong id="rds_01_0002__b16454501416">ESSD</strong>: extreme SSD storage.</li></ul>
|
|
<div class="note" id="rds_01_0002__note53993655015"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="rds_01_0002__ul13221057105417"><li id="rds_01_0002__li62228576548">The MySQL and PostgreSQL DB engines support the following volume types: <strong id="rds_01_0002__b16873111595819">CLOUDSSD</strong> and <strong id="rds_01_0002__b1056111975811">ESSD</strong>. <strong id="rds_01_0002__b7935212141919">ESSD</strong> is not supported for Single instance types for MySQL and PostgreSQL.</li><li id="rds_01_0002__li18222557195416">The SQL Server engine supports the following volume types: <strong id="rds_01_0002__b15403185214573">COMMON</strong>, <strong id="rds_01_0002__b54822115819">ULTRAHIGH</strong>, and <strong id="rds_01_0002__b1461048165816">ESSD</strong>.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row42343927"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.7.2.5.1.1 "><p id="rds_01_0002__p7306053">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.7.2.5.1.2 "><p id="rds_01_0002__p54919424">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.7.2.5.1.3 "><p id="rds_01_0002__p19288335">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35%" headers="mcps1.3.3.7.2.5.1.4 "><p id="rds_01_0002__p18851291">Specifies the volume size.</p>
|
|
<p id="rds_01_0002__p1878135135412">Its value must be a multiple of 10 and the value range is from 40 GB to 4000 GB.</p>
|
|
<div class="note" id="rds_01_0002__note02685513325"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_01_0002__p385416153310">For read replicas, this parameter is invalid. The volume size is the same as that of the primary DB instance by default.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table992615211258"></a><a name="table992615211258"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table992615211258" frame="border" border="1" rules="all"><caption><b>Table 8 </b>chargeInfo field data structure description</caption><thead align="left"><tr id="rds_01_0002__row139830521259"><th align="left" class="cellrowborder" valign="top" width="19.491949194919492%" id="mcps1.3.3.8.2.5.1.1"><p id="rds_01_0002__p18997135202515"><strong id="rds_01_0002__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.67256725672567%" id="mcps1.3.3.8.2.5.1.2"><p id="rds_01_0002__p4995352514"><strong id="rds_01_0002__b916371947">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.13201320132013%" id="mcps1.3.3.8.2.5.1.3"><p id="rds_01_0002__p7219531251"><strong id="rds_01_0002__b221124618">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.703470347034695%" id="mcps1.3.3.8.2.5.1.4"><p id="rds_01_0002__p143485310253"><strong id="rds_01_0002__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row44865311257"><td class="cellrowborder" valign="top" width="19.491949194919492%" headers="mcps1.3.3.8.2.5.1.1 "><p id="rds_01_0002__p147051450112610">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.67256725672567%" headers="mcps1.3.3.8.2.5.1.2 "><p id="rds_01_0002__p170519503263">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.13201320132013%" headers="mcps1.3.3.8.2.5.1.3 "><p id="rds_01_0002__p3705750182610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.703470347034695%" headers="mcps1.3.3.8.2.5.1.4 "><p id="rds_01_0002__p13419304384">Specifies the billing mode.</p>
|
|
<p id="rds_01_0002__p134812510201">The value <strong id="rds_01_0002__b950011618311">postPaid</strong> indicates the pay-per-use billing mode.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table951671018275"></a><a name="table951671018275"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table951671018275" frame="border" border="1" rules="all"><caption><b>Table 9 </b>unchangeable_param field data structure description</caption><thead align="left"><tr id="rds_01_0002__row1551791013279"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.9.2.5.1.1"><p id="rds_01_0002__p1051761015277"><strong id="rds_01_0002__b53605455711">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.13%" id="mcps1.3.3.9.2.5.1.2"><p id="rds_01_0002__p251741062717"><strong id="rds_01_0002__b190221141">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.63%" id="mcps1.3.3.9.2.5.1.3"><p id="rds_01_0002__p951791002715"><strong id="rds_01_0002__b1164530342">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.24%" id="mcps1.3.3.9.2.5.1.4"><p id="rds_01_0002__p115172105272"><strong id="rds_01_0002__b0505911153118">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row17517151082718"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.9.2.5.1.1 "><p id="rds_01_0002__p751713106276">lower_case_table_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.9.2.5.1.2 "><p id="rds_01_0002__p135171210112716">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.63%" headers="mcps1.3.3.9.2.5.1.3 "><p id="rds_01_0002__p25171510112716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.24%" headers="mcps1.3.3.9.2.5.1.4 "><p id="rds_01_0002__p1651791052710">Whether table names are case sensitive. The default value is <span class="parmvalue" id="rds_01_0002__parmvalue158051223181111"><b>1</b></span>. </p>
|
|
<p id="rds_01_0002__p7195189153116">Value range:</p>
|
|
<ul id="rds_01_0002__ul17195189173113"><li id="rds_01_0002__li6195209133111"><strong id="rds_01_0002__b194393335314">0</strong>: Table names are fixed and case sensitive.</li><li id="rds_01_0002__li201959914314"><strong id="rds_01_0002__b383172511539">1</strong>: Table names are stored in lowercase and are case insensitive.</li></ul>
|
|
<div class="note" id="rds_01_0002__note1447134092619"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_01_0002__p1747194012618">When data is restored to an existing DB instance, the case sensitivity setting of the existing DB instance must be the same as that of the original DB instance. Otherwise, the restoration may fail.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="rds_01_0002__ul31633354180"><li id="rds_01_0002__li4411135064210">Example<p id="rds_01_0002__p1454414211213"><a name="rds_01_0002__li4411135064210"></a><a name="li4411135064210"></a>POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances</p>
|
|
</li></ul>
|
|
<ul id="rds_01_0002__ul10190321"><li id="rds_01_0002__li24604028">Request example<p id="rds_01_0002__p20109663"><a name="rds_01_0002__li24604028"></a><a name="li24604028"></a>Creating a single DB instance:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock1825871483916">{
|
|
"name": "rds-instance-rep2",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "8.0"
|
|
},
|
|
"flavor_ref": "rds.mysql.n1.large",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01",
|
|
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
|
|
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
|
|
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
|
|
"port": 8635,
|
|
"backup_strategy": {
|
|
"start_time": "08:15-09:15",
|
|
"keep_days": 12
|
|
},
|
|
"charge_info": {
|
|
"charge_mode": "postPaid"
|
|
},
|
|
"password": "Test@12345678",
|
|
"configuration_id": "452408-ef4b-44c5-94be-305145fg",
|
|
"unchangeable_param": {
|
|
"lower_case_table_names": "1"
|
|
}
|
|
}</pre>
|
|
<p id="rds_01_0002__p33599791">Creating primary/standby DB instances:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock39219017488">{
|
|
"name": "rds-instance-rep2",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "8.0"
|
|
},
|
|
"ha": {
|
|
"mode": "ha",
|
|
"replication_mode": "semisync"
|
|
},
|
|
"flavor_ref": "rds.mysql.n1.large.ha",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01,eu-de-02",
|
|
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
|
|
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
|
|
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
|
|
"port": 8635,
|
|
"backup_strategy": {
|
|
"start_time": "08:15-09:15",
|
|
"keep_days": 12
|
|
},
|
|
"charge_info": {
|
|
"charge_mode": "postPaid"
|
|
},
|
|
"password": "Test@12345678",
|
|
"configuration_id": "452408-ef4b-44c5-94be-305145fg"
|
|
}</pre>
|
|
<p id="rds_01_0002__p18099233715"></p>
|
|
<p id="rds_01_0002__p162113163198"></p>
|
|
<p id="rds_01_0002__p14704193675318"></p>
|
|
<p id="rds_01_0002__p14734188">Creating a read replica:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock117121164419">{
|
|
"name": "rds-instance-rep2",
|
|
"replica_of_id": "afdsad-fds-fdsagin01",
|
|
"flavor_ref": "rds.mysql.n1.large.rr",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0002__section36749739"><h4 class="sectiontitle">Response</h4><ul id="rds_01_0002__ul48268995"><li id="rds_01_0002__li31767774">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table17474517" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0002__row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_01_0002__p32787233"><strong id="rds_01_0002__b1923318131915">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.29%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_01_0002__p38520254"><strong id="rds_01_0002__b224313917193">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_01_0002__p33132859"><strong id="rds_01_0002__b2187181012195">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row66515904"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0002__p19079158">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0002__p148451042014">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0002__p48735027">Indicates the DB instance information.</p>
|
|
<p id="rds_01_0002__p31211412488">For details, see <a href="#rds_01_0002__table175305610274">Table 11</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0002__p1165525810503">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0002__p116551958135013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0002__p16655115865012">Indicates the ID of the DB instance creation task.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table175305610274"></a><a name="table175305610274"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table175305610274" frame="border" border="1" rules="all"><caption><b>Table 11 </b>instance field data structure description</caption><thead align="left"><tr id="rds_01_0002__row4782256142718"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_01_0002__p11791105616272"><strong id="rds_01_0002__b3479182912209">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="rds_01_0002__p1280910568278"><strong id="rds_01_0002__b19212231152015">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="rds_01_0002__p081620561276"><strong id="rds_01_0002__b141701329208">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row83685201297"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p109879468293">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p14953885305">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p1798714612914">Indicates the DB instance ID.</p>
|
|
<div class="note" id="rds_01_0002__note10609835155910"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_01_0002__p1661116354596">The v3 DB instance ID is incompatible with the v1 DB instance ID.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row88231562277"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p383295682710">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p48498568273">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p1785918563276">Indicates the DB instance name. Indicates the DB instance name. DB instances of the same type can have same names under the same tenant.</p>
|
|
<p id="rds_01_0002__p168621956132710">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="rds_01_0002__row1326042683017"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p986116344302">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p4861203433016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p78617346309">Indicates the DB instance status. For example, <strong id="rds_01_0002__b9548194552618">BUILD</strong> indicates that the DB instance is being created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1587195662712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p188761056132717">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1420620152206">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p13907115612720">Indicates the database information.</p>
|
|
<p id="rds_01_0002__p3202172191616">For details, see <a href="#rds_01_0002__table766045720277">Table 12</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row2091115617278"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p15919756162716">ha</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p5393917192016">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p11951155662714">Indicates the HA configuration parameters. This parameter is returned only when primary/standby DB instances are created.</p>
|
|
<p id="rds_01_0002__p175371517131617">For details, see <a href="#rds_01_0002__table15899105722713">Table 13</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row2095545611272"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p189601356162713">configuration_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1697725682718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p198515563273">Indicates the parameter template ID. This parameter is returned only when a custom parameter template is used during DB instance creation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1299345602718"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p20311571272">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1923157132717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p1133155782713">Indicates the database port, which is the same as the request parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row711835715271"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p8127757182713">backup_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p112581220112016">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p3151145732716">Indicates the automated backup policy.</p>
|
|
<p id="rds_01_0002__p1727510419167">For details, see <a href="#rds_01_0002__table81249589270">Table 14</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row11961857142710"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p420435702717">disk_encryption_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p2219205782710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p12644165011499">Indicates the key ID for disk encryption. By default, this parameter is empty and is returned only when it is specified during the DB instance creation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1023011571273"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p62375571274">flavor_ref</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p12250057172719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p236414121179">Indicates the specification code. The value cannot be empty.</p>
|
|
<p id="rds_01_0002__p7368101291717">For details, see <span class="parmname" id="rds_01_0002__parmname33904329319"><b>spec_code</b></span> in <a href="rds_06_0002.html#rds_06_0002__table1336414511696">Table 3</a> in section <a href="rds_06_0002.html">Querying Database Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row727255762713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p22816576279">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1127219238200">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p16313145722718">Indicates the volume information.</p>
|
|
<p id="rds_01_0002__p9926555171610">For details, see <a href="#rds_01_0002__table5324165817272">Table 15</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1331675710271"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p132655742711">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p83409571274">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p9347357152716">Indicates the region ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row04101057112715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p441975772719">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p7431165752717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p104381557182713">Indicates the AZ ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row54992572275"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p14507155732716">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1522205719275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p7759131604512">Indicates the VPC ID. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul475921618452"><li id="rds_01_0002__en-us_topic_0224329974_li67651171359">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="rds_01_0002__en-us_topic_0224329974_li948317405377">Method 2: See the "Querying VPCs" section in the <em id="rds_01_0002__en-us_topic_0224329974_i842352697165629">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row4544757192710"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p125528573274">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p20568457112711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p27596160451">Indicates the network ID. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul375971611456"><li id="rds_01_0002__en-us_topic_0224329974_li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="rds_01_0002__en-us_topic_0224329974_b4101174416409">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="rds_01_0002__li1626657149">Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in <em id="rds_01_0002__i142661571444">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row158217577276"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p7590145715274">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p9603205716276">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p157601616114517">Indicates the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods:</p>
|
|
<ul id="rds_01_0002__ul37601616154512"><li id="rds_01_0002__en-us_topic_0224329974_li94054222421">Method 1: Log in to VPC console. Choose <strong id="rds_01_0002__en-us_topic_0224329974_b1913676122">Access Control</strong> > <strong id="rds_01_0002__en-us_topic_0224329974_b789502111219">Security Groups</strong> in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.</li><li id="rds_01_0002__en-us_topic_0224329974_li17405132214423">Method 2: See the "Querying Security Groups" section in the <em id="rds_01_0002__en-us_topic_0224329974_i2369584559">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row0196133117331"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p020245918349">charge_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p16860202662013">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p132021959163412">Indicates the billing information, which is pay-per-use.</p>
|
|
<p id="rds_01_0002__p1755410518172">For details, see <a href="#rds_01_0002__table207147873611">Table 16</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row1638011291745"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0002__p164971825172918">collation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0002__p1049718255294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0002__p1449772542912">Indicates the collation set for Microsoft SQL Server.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table766045720277"></a><a name="table766045720277"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table766045720277" frame="border" border="1" rules="all"><caption><b>Table 12 </b>datastore field data structure description</caption><thead align="left"><tr id="rds_01_0002__row468335722716"><th align="left" class="cellrowborder" valign="top" width="19.17%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_01_0002__p156891357202720"><strong id="rds_01_0002__b1981643284612">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.3%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_01_0002__p77089577277"><strong id="rds_01_0002__b1639043514465">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.53%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_01_0002__p13715557112714"><strong id="rds_01_0002__b272823624615">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row9723165742714"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_01_0002__p17321257162715">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_01_0002__p17521757192712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.53%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_01_0002__p1734174217233">Indicates the DB engine. Value:</p>
|
|
<ul id="rds_01_0002__ul137341742112314"><li id="rds_01_0002__li07341542142313">MySQL</li><li id="rds_01_0002__li16734134215237">PostgreSQL</li><li id="rds_01_0002__li273454213235">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row37937570272"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_01_0002__p10800165713279">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_01_0002__p0819195719271">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.53%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_01_0002__p1957105533718">Indicates the database version.</p>
|
|
<p id="rds_01_0002__p71501555377">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="rds_01_0002__table15899105722713"></a><a name="table15899105722713"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table15899105722713" frame="border" border="1" rules="all"><caption><b>Table 13 </b>ha field data structure description</caption><thead align="left"><tr id="rds_01_0002__row1393295712715"><th align="left" class="cellrowborder" valign="top" width="19.31%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="rds_01_0002__p2941125719278"><strong id="rds_01_0002__b2060931019487">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.229999999999997%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="rds_01_0002__p119521157162710"><strong id="rds_01_0002__b1595731515483">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.459999999999994%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="rds_01_0002__p15960175762715"><strong id="rds_01_0002__b153161217104811">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row1965185792714"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="rds_01_0002__p179729572279">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.229999999999997%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="rds_01_0002__p14990257142711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="rds_01_0002__p4997155711270">Indicates the DB instance type. The value is <strong id="rds_01_0002__b1731261515142">Ha</strong> (primary/standby DB instances).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row72115815278"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="rds_01_0002__p29658162714">replication_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.229999999999997%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="rds_01_0002__p1023185852714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="rds_01_0002__p633115816277">Indicates the replication mode for the standby DB instance. This parameter is valid when the <strong id="rds_01_0002__b16915165181410">mode</strong> is <strong id="rds_01_0002__b791675181411">Ha</strong>.</p>
|
|
<p id="rds_01_0002__p1837105812718">Value:</p>
|
|
<ul id="rds_01_0002__ul184125872719"><li id="rds_01_0002__li14585814274">For MySQL, the value is <strong id="rds_01_0002__b61924266493">async</strong> or <strong id="rds_01_0002__b819332654913">semisync</strong>.</li><li id="rds_01_0002__li251145812275">For PostgreSQL, the value is <strong id="rds_01_0002__b1676132994915">async</strong> or <strong id="rds_01_0002__b17623290494">sync</strong>.</li><li id="rds_01_0002__li155955852717">For Microsoft SQL Server, the value is <strong id="rds_01_0002__b72418327496">sync</strong>.</li></ul>
|
|
<div class="note" id="rds_01_0002__note575155882717"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="rds_01_0002__ul593135817276"><li id="rds_01_0002__li596185813272"><strong id="rds_01_0002__b209335194918">async</strong> indicates the asynchronous replication mode.</li><li id="rds_01_0002__li510417581279"><strong id="rds_01_0002__b6463816497">semisync</strong> indicates the semi-synchronous replication mode.</li><li id="rds_01_0002__li911375882716"><strong id="rds_01_0002__b4648540124911">sync</strong> indicates the synchronous replication mode.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table81249589270"></a><a name="table81249589270"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table81249589270" frame="border" border="1" rules="all"><caption><b>Table 14 </b>backupStrategy field data structure description</caption><thead align="left"><tr id="rds_01_0002__row7155105822719"><th align="left" class="cellrowborder" valign="top" width="20.810000000000002%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="rds_01_0002__p151651758112710"><strong id="rds_01_0002__b1317048124917">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.21%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="rds_01_0002__p818335813276"><strong id="rds_01_0002__b1658905013490">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.980000000000004%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="rds_01_0002__p14192195817274"><strong id="rds_01_0002__b58027515491">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row1220112589270"><td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="rds_01_0002__p321175814278">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.21%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="rds_01_0002__p16233758102717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="rds_01_0002__p9542823183517">Specifies the backup time window. Automated backups will be triggered during the backup time window.</p>
|
|
<p id="rds_01_0002__p122470773718">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="rds_01_0002__ul152511713710"><li id="rds_01_0002__li10256157153712">The <strong id="rds_01_0002__b47116919575">HH</strong> value must be 1 greater than the <strong id="rds_01_0002__b147210975710">hh</strong> value.</li><li id="rds_01_0002__li182663715377">The values of <strong id="rds_01_0002__b4517171220573">mm</strong> and <strong id="rds_01_0002__b751912121579">MM</strong> must be the same and must be set to any of the following: <strong id="rds_01_0002__b65191612185719">00</strong>, <strong id="rds_01_0002__b1252117129570">15</strong>, <strong id="rds_01_0002__b652313123574">30</strong>, or <strong id="rds_01_0002__b15241112195713">45</strong>.</li></ul>
|
|
<p id="rds_01_0002__p18280157153716">Example value:</p>
|
|
<ul id="rds_01_0002__ul132861073374"><li id="rds_01_0002__li1029219793710">08:15-09:15</li><li id="rds_01_0002__li19304143714352">23:00-00:00</li></ul>
|
|
<p id="rds_01_0002__p17846943163516">If <span class="parmname" id="rds_01_0002__parmname87264315208"><b>backup_strategy</b></span> in the request body is empty, <span class="parmvalue" id="rds_01_0002__parmvalue167315432201"><b>02:00-03:00</b></span> is returned for <span class="parmname" id="rds_01_0002__parmname57384320206"><b>start_time</b></span> by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row162581058122711"><td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="rds_01_0002__p8266145882712">keep_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.21%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="rds_01_0002__p9286558152710">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="rds_01_0002__p229865817274">Indicates the retention days for specific backup files.</p>
|
|
<p id="rds_01_0002__p1230285817274">The value range is from 0 to 732. If this parameter is not specified or set to <strong id="rds_01_0002__b154931332175017">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>
|
|
<p id="rds_01_0002__p13596123011365">If <span class="parmname" id="rds_01_0002__parmname135371651182016"><b>backup_strategy</b></span> in the request body is empty, <span class="parmvalue" id="rds_01_0002__parmvalue1153895192014"><b>7</b></span> is returned for <span class="parmname" id="rds_01_0002__parmname165381351172018"><b>keep_days</b></span> by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table5324165817272"></a><a name="table5324165817272"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table5324165817272" frame="border" border="1" rules="all"><caption><b>Table 15 </b>volume field data structure description</caption><thead align="left"><tr id="rds_01_0002__row13366558182710"><th align="left" class="cellrowborder" valign="top" width="20.87%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="rds_01_0002__p43785583277"><strong id="rds_01_0002__b89163418503">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="rds_01_0002__p04002058182712"><strong id="rds_01_0002__b588819452509">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.75%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="rds_01_0002__p1841019583272"><strong id="rds_01_0002__b99501546155010">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row1941717585272"><td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="rds_01_0002__p542455816278">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="rds_01_0002__p8441115892715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.75%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="rds_01_0002__p144508584276">Indicates the volume type.</p>
|
|
<p id="rds_01_0002__p788415113303">Its value can be any of the following and is case-sensitive:</p>
|
|
<ul id="rds_01_0002__ul97191143171815"><li id="rds_01_0002__rds_01_0002_li17711857191312"><strong id="rds_01_0002__rds_01_0002_b175811447151011">COMMON</strong>: SATA storage.</li><li id="rds_01_0002__rds_01_0002_li1671115572136"><strong id="rds_01_0002__rds_01_0002_b692704062510">ULTRAHIGH</strong>: ultra-high I/O storage.</li><li id="rds_01_0002__rds_01_0002_li882154133612"><strong id="rds_01_0002__rds_01_0002_b962134413123">CLOUDSSD</strong>: cloud SSD storage.</li><li id="rds_01_0002__rds_01_0002_li1186817447711"><strong id="rds_01_0002__rds_01_0002_b16454501416">ESSD</strong>: extreme SSD storage.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0002__row164658587274"><td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="rds_01_0002__p1247475842718">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="rds_01_0002__p1549255811272">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.75%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="rds_01_0002__p7502958132716">Indicates the volume size.</p>
|
|
<p id="rds_01_0002__p251014588279">Its value range is from 40 GB to 4000 GB. The value must be a multiple of 10.</p>
|
|
<p id="rds_01_0002__p8725181468"></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0002__table207147873611"></a><a name="table207147873611"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0002__table207147873611" frame="border" border="1" rules="all"><caption><b>Table 16 </b>chargeInfo field data structure description</caption><thead align="left"><tr id="rds_01_0002__row1577020823612"><th align="left" class="cellrowborder" valign="top" width="20.72%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="rds_01_0002__p178613803619"><strong id="rds_01_0002__b92145966">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.82%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="rds_01_0002__p281617863613"><strong id="rds_01_0002__b1642553666">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.459999999999994%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="rds_01_0002__p98254810367"><strong id="rds_01_0002__b229526089">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0002__row188358873611"><td class="cellrowborder" valign="top" width="20.72%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0002__p2611995378">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.82%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0002__p1161892377">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.459999999999994%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0002__p1161169163719">Indicates the billing information, which is pay-per-use.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_01_0002__ul50009058"><li id="rds_01_0002__li47428342">Example normal response<p id="rds_01_0002__p24201902"><a name="rds_01_0002__li47428342"></a><a name="li47428342"></a>Creating a single DB instance:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock113661331633">{
|
|
"instance": {
|
|
"id": "dsfae23fsfdsae3435in01",
|
|
"name": "trove-instance-rep2",
|
|
"status": "BUILD",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "8.0"
|
|
},
|
|
"flavor_ref": "rds.mysql.n1.large",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01",
|
|
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
|
|
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
|
|
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
|
|
"port": "8635",
|
|
"backup_strategy": {
|
|
"start_time": "08:15-09:15",
|
|
"keep_days": 3
|
|
},
|
|
"configuration_id": "452408-44c5-94be-305145fg",
|
|
"charge_info": {
|
|
"charge_mode": "postPaid"
|
|
}
|
|
},
|
|
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
|
|
}</pre>
|
|
<p id="rds_01_0002__p51347269">Creating primary/standby DB instances:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock4393424573">{
|
|
"instance":{
|
|
"id": "dsfae23fsfdsae3435in01",
|
|
"name": "trove-instance-rep2",
|
|
"status": "BUILD",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "8.0"
|
|
},
|
|
"ha": {
|
|
"mode": "ha",
|
|
"replication_mode": "semisync"
|
|
},
|
|
"flavor_ref": "rds.mysql.n1.large.ha",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01,en-de-02",
|
|
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
|
|
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
|
|
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
|
|
"port": "8635",
|
|
"backup_strategy": {
|
|
"start_time": "08:15-09:15",
|
|
"keep_days": 3
|
|
},
|
|
"configuration_id": "452408-44c5-94be-305145fg",
|
|
"charge_info": {
|
|
"charge_mode": "postPaid"
|
|
},
|
|
},
|
|
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
|
|
}</pre>
|
|
<p id="rds_01_0002__p432844113509"></p>
|
|
<p id="rds_01_0002__p15426191510103">Creating a read replica:</p>
|
|
<pre class="codeblock" id="rds_01_0002__codeblock1037544005811">{
|
|
"instance":{
|
|
"id": "dsfae23fsfdsae3435in01",
|
|
"name": "trove-instance-rep2",
|
|
"status": "BUILD",
|
|
"datastore": {
|
|
"type": "PostgreSQL",
|
|
"version": 13
|
|
},
|
|
"flavor_ref": "rds.mysql.n1.large.rr",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
|
"region": "eu-de",
|
|
"availability_zone": "eu-de-01",
|
|
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
|
|
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
|
|
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
|
|
"port": "8635",
|
|
"configuration_id": "452408-44c5-94be-305145fg",
|
|
"charge_info": {
|
|
"charge_mode": "postPaid"
|
|
}
|
|
},
|
|
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
|
|
|
|
}</pre>
|
|
</li><li id="rds_01_0002__li676912419816">Abnormal Response<p id="rds_01_0002__p29415884"><a name="rds_01_0002__li676912419816"></a><a name="li676912419816"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_01_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_01_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_01_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_01_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_01_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_01_0002__en-us_topic_0032347778_p0723374409"><a name="rds_01_0002__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_01_0002__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|