vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_newapi_0027.html
Ru, Li Yi d97aea4dd2 opengauss_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-09-06 09:04:21 +00:00

753 lines
67 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001917130460"></a><a name="EN-US_TOPIC_0000001917130460"></a>
<h1 class="topictitle1">Restoring Data to a New DB Instance</h1>
<div id="body0000001295867069"><div class="section" id="EN-US_TOPIC_0000001917130460__section1256399154120"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917130460__p175643915414">This API is used to restore data to a new DB instance using backups. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__section195648984114"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001917130460__p1947218140194">The DB engine versions and instance types of the original and new instances must be the same.</p>
<p id="EN-US_TOPIC_0000001917130460__p187515397112">The specifications of the new instance must be greater than or equal to those of the original instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__section7564593414"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917130460__ul8362131425417"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>POST https://{<em id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/instances</p>
</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances</p>
</li><li id="EN-US_TOPIC_0000001917130460__li186581317195613">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__table85657994113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row1656514918412"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p1756510913417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p55657994118">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p135651396413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row1756519164114"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p6565159154110">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p85661934111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p19528455451">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917130460__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__section185660944113"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__request_OpengaussRestoreInstanceRequest" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row656913917418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917130460__p85695974113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.96%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917130460__p1256959174110">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.02%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917130460__p115709916418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.02%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000001917130460__p85701899416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row756916974115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p757011934115">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p45701992417">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p125708964113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p9621115320014">DB instance name.</p>
<p id="EN-US_TOPIC_0000001917130460__p1828011491001">Instances of the same type can have same names under the same tenant.</p>
<p id="EN-US_TOPIC_0000001917130460__p657069164112">The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row15569091415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p4570199184119">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p16570093418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p135714934113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p1657119164119">AZ ID.</p>
<p id="EN-US_TOPIC_0000001917130460__p786411213309">The value cannot be left blank. You can deploy <span id="EN-US_TOPIC_0000001917130460__text976116112914">GaussDB</span> in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul395532333011"><li id="EN-US_TOPIC_0000001917130460__li1795514234308">To deploy a DB instance in the same AZ, enter three same AZ IDs. </li><li id="EN-US_TOPIC_0000001917130460__li1688312501302">To deploy a DB instance across three different AZs, enter three different AZ IDs.</li></ul>
<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p49296060141410">The value cannot be left blank. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row156969104115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p185711092415">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p15571179114111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p35714924114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p1157189184111">Specification code. The value cannot be empty. For details on how to obtain the <span id="EN-US_TOPIC_0000001917130460__text15141312918">GaussDB</span> specification code, see <a href="opengauss_api_0037.html">DB Instance Specifications</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row95693924110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p205711192415">volume</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p65716915413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p44233713193">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p55726912417">Volume information.</p>
<p id="EN-US_TOPIC_0000001917130460__p11602104153117">For details, see <a href="#EN-US_TOPIC_0000001917130460__request_OpenGaussVolume">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row0569199204118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p11572495418">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p15729914412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p185737915419">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p10573695412">VPC ID. To obtain this parameter value, use the following methods:</p>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul250415512347"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li67651171359">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li948317405377">Method 2: See the section "Querying VPCs" in the <em id="EN-US_TOPIC_0000001917130460__i112641290509">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row2056939144112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p125736914116">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p657318910417">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1257349154111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p512371711393">Network ID. To obtain this parameter value, use either of the following methods:</p>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul9152102763919"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="EN-US_TOPIC_0000001917130460__b4271356185417">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li14903124220396">Method 2: See the section "Querying Subnets" in the <em id="EN-US_TOPIC_0000001917130460__i1173211635515">Virtual Private Cloud API Reference</em>.</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li073418475515">Method 2: See section "Querying Subnets" under "APIs" or "Querying Networks" under "OpenStack Neutron APIs" in <em id="EN-US_TOPIC_0000001917130460__i15991510115517">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row35691984119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1757329194115">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p25376232">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p157411911411">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p193681417164213">Security group which the instance is associated with. To obtain this parameter value, use either of the following methods: </p>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul16404122194211"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li94054222421">Method 1: Log in to VPC console. Choose <strong id="EN-US_TOPIC_0000001917130460__b152891015145510">Access Control</strong> &gt; <strong id="EN-US_TOPIC_0000001917130460__b1628991516558">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="EN-US_TOPIC_0000001917130460__en-us_topic_0000001703994577_en-us_topic_0128427213_li17405132214423">Method 2: See the section "Querying Security Groups" in the <em id="EN-US_TOPIC_0000001917130460__i7941828125518">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row8569498415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p19574398412">password</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p2574891413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p115741698415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p65746974113">Database password.</p>
<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p222911345011">The password must:</p>
<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p1357617168505">Consist of 8 to 32 characters and include at least three of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#%^*-_=+?,).</p>
<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p12429628144458">Enter a strong password to improve security, preventing security risks such as brute force cracking.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row95691099419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p145741598414">charge_info</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p175751991412">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p14575119144118">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p7575129204116">Billing mode, which can be pay-per-use.</p>
<p id="EN-US_TOPIC_0000001917130460__p18511759183310">For details, see <a href="#EN-US_TOPIC_0000001917130460__request_OpenGaussChargeInfo">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row16267153111815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p135751195419">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1757616919416">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p264195925912">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p185761293419">Automated backup policy.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row17569191415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p857529164118">restore_point</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p95758944113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p158661857125911">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p2575891419">Restoration information.</p>
<p id="EN-US_TOPIC_0000001917130460__p47965479334">For details, see <a href="#EN-US_TOPIC_0000001917130460__request_RestorePoint">Table 5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1856999144114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p175768934111">configuration_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p957715974110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p657716919419">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p1257739184118">Parameter template ID. If this parameter is not specified, the default parameter template is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row12569196413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1557713944115">port</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p95776974115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p12578119154112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p8945165018306">Port number used by the database to provide services for external systems, ranging from 1024 to 39998. It cannot be set to the default value <strong id="EN-US_TOPIC_0000001917130460__b23470428710637">8000</strong>. The following ports are not allowed: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row356910912419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p11578189154116">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p95781974114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1557899154113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p68612171854">UTC time zone.</p>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul5219145811464"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_li56011541445">If this parameter is not specified, <span id="EN-US_TOPIC_0000001917130460__text1947252016295">GaussDB</span> uses UTC by default.</li></ul>
<ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_ul2336191915511"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_li8993153632514">If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be <strong id="EN-US_TOPIC_0000001917130460__b2959214654">UTC+08:00</strong> rather than <strong id="EN-US_TOPIC_0000001917130460__b1695910141656">UTC+08:30</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row3569197412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p757920916416">enable_force_switch</p>
</td>
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p175791890415">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p15790964119">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p362364133017">Whether to forcibly promote a standby node to primary. The value can only be <strong id="EN-US_TOPIC_0000001917130460__b150053867410637">true</strong> or <strong id="EN-US_TOPIC_0000001917130460__b127718338410637">false</strong>.</p>
<p id="EN-US_TOPIC_0000001917130460__p557916964113"><strong id="EN-US_TOPIC_0000001917130460__b8849102618155">true</strong>: The function is enabled. <strong id="EN-US_TOPIC_0000001917130460__b1221112359151">false</strong>: (default value) The function is disabled. Only 1.2.2 and later versions are supported.</p>
<div class="note" id="EN-US_TOPIC_0000001917130460__note657913461312"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001917130460__p357954610314">The function is suitable for the following scenario: When the primary node is faulty, a standby node is forcibly promoted to primary to provide services, ensuring the instance availability. When the instance is faulty, this function is used to recover services as soon as possible at the cost of partial data loss. You are not advised to use this function if you are not clear about the impact of data loss on services.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__request_OpenGaussVolume"></a><a name="request_OpenGaussVolume"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__request_OpenGaussVolume" frame="border" border="1" rules="all"><caption><b>Table 3 </b>volume field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row757920914411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001917130460__p1458029134118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001917130460__p2058059154115">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001917130460__p758059134116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001917130460__p15801954111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row457912914414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1758020964119">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p658118924117">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p858115914416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p058117914410">Disk type.</p>
<p id="EN-US_TOPIC_0000001917130460__p168521095014">Only <strong id="EN-US_TOPIC_0000001917130460__b1222681433210">ULTRAHIGH</strong> is supported, which indicates the local disk.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row155791298412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p258212911411">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p19582390419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p75823964112">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p18851291">Storage space, which must be at least that of the original DB instance. For example, if this parameter is set to <strong id="EN-US_TOPIC_0000001917130460__b29719356210637">40</strong>, 40 GB of storage is allocated to the instance.</p>
<p id="EN-US_TOPIC_0000001917130460__p135201653447">ECS deployment: The value must be a multiple of (Number of shards x 40 GB), ranging from (Number of shards x 40 GB) to (Number of shards x 16 TB).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__request_OpenGaussChargeInfo"></a><a name="request_OpenGaussChargeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__request_OpenGaussChargeInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>charge_info field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row1058213915419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001917130460__p1258369184111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001917130460__p7583129134116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001917130460__p1758314920411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001917130460__p258369204116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row10583139154115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p258329134114">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p175831918418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1058416944113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p1458416954116">Billing mode. <strong id="EN-US_TOPIC_0000001917130460__b13915513124711">postPaid</strong>: pay-per-use billing. </p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__request_RestorePoint"></a><a name="request_RestorePoint"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__request_RestorePoint" frame="border" border="1" rules="all"><caption><b>Table 5 </b>restore_point field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row1858415914120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000001917130460__p858416918415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000001917130460__p1258515912415">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000001917130460__p1658559134116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000001917130460__p1058516910419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row105847916419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p55854916411">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p185854914115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p5585197418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p16585992413">Source instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1558417919413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1758618904117">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p11586189124119">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p25861699412">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p75861899416">ID of the backup to be restored.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1933618512911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p563955913819">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p186403597389">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1564011596383">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p156409599383">Restoration type. Value:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul166401759193814"><li id="EN-US_TOPIC_0000001917130460__li14640459163815"><strong id="EN-US_TOPIC_0000001917130460__b1437379426">backup</strong>: indicates data is restored using backups. In this mode, <strong id="EN-US_TOPIC_0000001917130460__b13193719424">type</strong> is optional and <strong id="EN-US_TOPIC_0000001917130460__b34163718428">backup_id</strong> is mandatory.</li><li id="EN-US_TOPIC_0000001917130460__li564011599385"><strong id="EN-US_TOPIC_0000001917130460__b78001053124218">timestamp</strong>: indicates data is restored using point-in-time recovery (PITR). In this mode, <strong id="EN-US_TOPIC_0000001917130460__b780195384215">type</strong> and <strong id="EN-US_TOPIC_0000001917130460__b11801653144212">restore_time</strong> are both mandatory.</li></ul>
<p id="EN-US_TOPIC_0000001917130460__p156401259143811">Value:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul664019597387"><li id="EN-US_TOPIC_0000001917130460__li4640459153814"><strong id="EN-US_TOPIC_0000001917130460__b764185911381">backup</strong></li><li id="EN-US_TOPIC_0000001917130460__li116411859203815"><strong id="EN-US_TOPIC_0000001917130460__b11641135953812">timestamp</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row32351927915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130460__p86411359103818">restore_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130460__p136418595386">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130460__p15641759123820">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130460__p76411159143814">Time point of data restoration in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__section28781117715"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0000001917130460__p174032538131">Restoring instance data</p>
<ul id="EN-US_TOPIC_0000001917130460__ul1470713245497"><li id="EN-US_TOPIC_0000001917130460__li47071424104917">Restoring data to a new DB instance. The new DB instance features 8 vCPUs, 64 GB memory, and 160 GB storage.<pre class="screen" id="EN-US_TOPIC_0000001917130460__screen1462631678">{
"name": "targetInst",
"availability_zone": "aaa,bbb,ccc",
"flavor_ref": "gaussdb.opengauss.ee.dn.m4.2xlarge.8.in",
"volume": {
"type": "ULTRAHIGH",
"size": 160
},
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
"password": "******",
"restore_point": {
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
"backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14"
},
"configuration_id": "52e86e87445847a79bf807ceda213165pr01",
"port": 8000,
"enable_force_switch": true,
"time_zone": "UTC+04:00"
}</pre>
</li><li id="EN-US_TOPIC_0000001917130460__li1548904424610">Restoring data to a new DB instance using backups. The new DB instance features 8 vCPUs, 64 GB memory, and 160 GB storage.<pre class="screen" id="EN-US_TOPIC_0000001917130460__screen15403165654612">{
"name": "targetInst",
"availability_zone": "aaa,bbb,ccc",
"flavor_ref": "gaussdb.opengauss.ee.dn.m4.2xlarge.8.in",
"volume": {
"type": "ULTRAHIGH",
"size": 160
},
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
"password": "******",
"restore_point": {
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
"backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14",
"type": "backup"
},
"configuration_id": "52e86e87445847a79bf807ceda213165pr01",
"port": 8000,
"enable_force_switch": true,
"time_zone": "UTC+04:00"
}</pre>
</li><li id="EN-US_TOPIC_0000001917130460__li13891121614815">Restoring data to a new DB instance using PITR. The new DB instance features 8 vCPUs, 64 GB memory, and 160 GB storage.<pre class="screen" id="EN-US_TOPIC_0000001917130460__screen11285144316484">{
"name": "targetInst",
"availability_zone": "aaa,bbb,ccc",
"flavor_ref": "gaussdb.opengauss.ee.dn.m4.2xlarge.8.in",
"volume": {
"type": "ULTRAHIGH",
"size": 160
},
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
"password": "******",
"restore_point": {
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
"type": "timestamp",
"restore_time": 1532001446987
},
"configuration_id": "52e86e87445847a79bf807ceda213165pr01",
"port": 8000,
"enable_force_switch": true,
"time_zone": "UTC+04:00"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__section5589199144118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917130460__ul10974145204513"><li id="EN-US_TOPIC_0000001917130460__li797419520455">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_CreateInstanceResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row45897974120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p458949174111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p85902911418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p85907917419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row85894914416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p15590498416">instance</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p2059017919415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p115908944112">Instance information.</p>
<p id="EN-US_TOPIC_0000001917130460__p1758295755314">For details, see <a href="#EN-US_TOPIC_0000001917130460__response_CreateInstanceRespItem">Table 7</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row125891493412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p359010914111">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p259015944117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p12590129124115">Task ID for restoring data to a new DB instance.</p>
<p id="EN-US_TOPIC_0000001917130460__p35906912412"></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__response_CreateInstanceRespItem"></a><a name="response_CreateInstanceRespItem"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_CreateInstanceRespItem" frame="border" border="1" rules="all"><caption><b>Table 7 </b>instance description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row1159169124110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p169716964117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p1697796411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p106975916411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row145912093419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p136971798414">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p569710924118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p569709204110">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row145916934114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1269716974120">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p12697149194116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1936965716488">DB instance name. Instances of the same type can have same names under the same tenant.</p>
<p id="EN-US_TOPIC_0000001917130460__p26978994114">The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row859179104115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p16973917411">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p86972974120">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p16697169174116">Instance status. For example, <strong id="EN-US_TOPIC_0000001917130460__b150285478010637">BUILD</strong> indicates that the instance is being created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row65917914111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p369729204120">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p42012212108">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p186971895418">Database information.</p>
<p id="EN-US_TOPIC_0000001917130460__p159672052161117">For details, see <a href="#EN-US_TOPIC_0000001917130460__response_OpenGaussDatastoreResponse">Table 8</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row14591129124111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p2697149134119">ha</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p46975913417">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p569749144117">Instance deployment model.</p>
<p id="EN-US_TOPIC_0000001917130460__p17577321141110">For details, see <a href="#EN-US_TOPIC_0000001917130460__response_OpenGaussHaResponse">Table 9</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row159149104113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p16977964111">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p136970974113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p669769104111">Database port. The default value is <strong id="EN-US_TOPIC_0000001917130460__b08571718151314">8000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row25911910415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p769720934119">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1580812615106">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p469720984119">Volume information.</p>
<p id="EN-US_TOPIC_0000001917130460__p1578094711015">For details, see <a href="#EN-US_TOPIC_0000001917130460__response_OpenGaussVolumeResponse">Table 10</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row285051122010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1978991216203">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p57890127208">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p7789812102014">Automated backup policy.</p>
<p id="EN-US_TOPIC_0000001917130460__p8790161272011">For details, see <a href="#EN-US_TOPIC_0000001917130460__table126510474157">Table 11</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row859113944120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p146977954110">replica_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p196971096417">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p369739154110">Number of replicas.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row6591199417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1869713964115">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p36971984112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p16529618320">Region ID.</p>
<p id="EN-US_TOPIC_0000001917130460__p49851431045">The value cannot be left blank. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1359179184119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p569814911413">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p2698119154119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1769817913415">Specification code.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row8591129104116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p169819194110">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p126985954111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p123681059135">AZ ID. You can deploy your instance in the same AZ or across three different AZs, and use commas (,) to separate AZs.</p>
<p id="EN-US_TOPIC_0000001917130460__p1361616221942">The value cannot be left blank. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row105910964116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p96981193416">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1469869194118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p769816934115">VPC ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1259199184117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p969810918413">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1769859164114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p17698139104118">Subnet ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row9591139174113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p06982914413">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1869869194116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p169879104114">Security group ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row359115944115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p16985915413">charge_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1257111118105">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1469811911418">Billing mode, which can be pay-per-use.</p>
<p id="EN-US_TOPIC_0000001917130460__p1060061611010">For details, see <a href="#EN-US_TOPIC_0000001917130460__response_OpenGaussChargeInfo">Table 12</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row18566111115178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p13566171120179">enable_parallel_restore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p1772334415173">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p4709188131811">Whether to support parallel restoration.</p>
<ul id="EN-US_TOPIC_0000001917130460__ul7838131918185"><li id="EN-US_TOPIC_0000001917130460__li1983871941812"><strong id="EN-US_TOPIC_0000001917130460__b4557105310113">false</strong>: not supported</li><li id="EN-US_TOPIC_0000001917130460__li18381219101817"><strong id="EN-US_TOPIC_0000001917130460__b143391233216">true</strong>: supported</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__response_OpenGaussDatastoreResponse"></a><a name="response_OpenGaussDatastoreResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_OpenGaussDatastoreResponse" frame="border" border="1" rules="all"><caption><b>Table 8 </b>datastore field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row759716914419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p36988913413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p769811954118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p569815974111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row155971390416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p2698199144119">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p169889174114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p86981091416">DB engine.</p>
<p id="EN-US_TOPIC_0000001917130460__p10698895414">Value:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul969869154111"><li id="EN-US_TOPIC_0000001917130460__li13698199411"><strong id="EN-US_TOPIC_0000001917130460__b1069820914415"><span id="EN-US_TOPIC_0000001917130460__text1958523136">GaussDB</span></strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row1759718944120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p12698149134112">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p569889104116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p156988910413">DB engine version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__response_OpenGaussHaResponse"></a><a name="response_OpenGaussHaResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_OpenGaussHaResponse" frame="border" border="1" rules="all"><caption><b>Table 9 </b>ha field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row135981498419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p136988913415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p1269819934117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p6698139134115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row859813910414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p196983910415">mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p16981990419">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p3698139164110">For distributed instances, the return value is <strong id="EN-US_TOPIC_0000001917130460__b1668534532917">enterprise</strong> (enterprise edition). For primary/standby instances, the return value is <strong id="EN-US_TOPIC_0000001917130460__b11685445182918">centralization_standard</strong> (primary/standby edition).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row859819915416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p36982912410">replication_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p56981999418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p186984910419">Replication mode for the standby node.</p>
<p id="EN-US_TOPIC_0000001917130460__p4698209164110">Value:</p>
<p id="EN-US_TOPIC_0000001917130460__p1178016591509"><strong id="EN-US_TOPIC_0000001917130460__b122584916290">sync</strong>.</p>
<div class="note" id="EN-US_TOPIC_0000001917130460__note167451487513"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001917130460__p157451289518"><strong id="EN-US_TOPIC_0000001917130460__b322544917312">sync</strong> indicates synchronous replication.</p>
</div></div>
<p id="EN-US_TOPIC_0000001917130460__p56985912411">Value:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul16698189124110"><li id="EN-US_TOPIC_0000001917130460__li169829104118"><strong id="EN-US_TOPIC_0000001917130460__b069812924113">sync</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row45981193418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p7698798414">consistency</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p76987913411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1069818954117">(<span id="EN-US_TOPIC_0000001917130460__text1655480578">GaussDB</span> reserved parameter) Transaction consistency type. The value can be <strong id="EN-US_TOPIC_0000001917130460__b3410529298">strong</strong> or <strong id="EN-US_TOPIC_0000001917130460__b84112527290">eventual</strong>.</p>
<p id="EN-US_TOPIC_0000001917130460__p1869818913411">Value:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul17698294417"><li id="EN-US_TOPIC_0000001917130460__li176982096417"><strong id="EN-US_TOPIC_0000001917130460__b116984934117">strong</strong></li><li id="EN-US_TOPIC_0000001917130460__li2698293418"><strong id="EN-US_TOPIC_0000001917130460__b13698159104114">eventual</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__response_OpenGaussVolumeResponse"></a><a name="response_OpenGaussVolumeResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_OpenGaussVolumeResponse" frame="border" border="1" rules="all"><caption><b>Table 10 </b>volume field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row18600398417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.5.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p1369810914414">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p1969879114111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p76986914415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row9600394416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1069869164111">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p26983920413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p76991699417">Disk type.</p>
<p id="EN-US_TOPIC_0000001917130460__p1769916924112">Its value is case-sensitive and can be:</p>
<ul id="EN-US_TOPIC_0000001917130460__ul126991198417"><li id="EN-US_TOPIC_0000001917130460__li569917918412"><strong id="EN-US_TOPIC_0000001917130460__b62285569910637">ULTRAHIGH</strong>: indicates the SSD.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row960012944117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p469912924110">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p96998910419">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p2699991413">Storage.</p>
<p id="EN-US_TOPIC_0000001917130460__p1069916924111">When restoring a distributed instance, you need to specify the storage to be a multiple of (Number of shards x 40 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__table126510474157"></a><a name="table126510474157"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__table126510474157" frame="border" border="1" rules="all"><caption><b>Table 11 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row1066647181516"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.6.2.1.6.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p066164716157">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.6.2.1.6.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p10661247131517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.2.1.6.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p166664713154">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row166618477150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.6.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p1674477151">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.6.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p26734791518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.2.1.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1567204711512">This field has been discarded.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130460__row206724761512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.6.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p156719472151">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.6.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p96744711155">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.2.1.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p6508132581">Retention days for specific backup files.</p>
<p id="EN-US_TOPIC_0000001917130460__p250883214813">Value: <strong id="EN-US_TOPIC_0000001917130460__b1353369907">0</strong> to <strong id="EN-US_TOPIC_0000001917130460__b921378726">732</strong>. If this parameter is not specified or is set to <strong id="EN-US_TOPIC_0000001917130460__b143881631720">0</strong>, the default value <strong id="EN-US_TOPIC_0000001917130460__b53882060171">7</strong> is used.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130460__response_OpenGaussChargeInfo"></a><a name="response_OpenGaussChargeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130460__response_OpenGaussChargeInfo" frame="border" border="1" rules="all"><caption><b>Table 12 </b>charge_info field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130460__row106041094416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.7.2.4.1.1"><p id="EN-US_TOPIC_0000001917130460__p6699990414">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.7.2.4.1.2"><p id="EN-US_TOPIC_0000001917130460__p96991994416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.7.2.4.1.3"><p id="EN-US_TOPIC_0000001917130460__p1269916920417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130460__row26045920419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130460__p166993915415">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130460__p96996984110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130460__p1059925017018">Billing mode. <strong id="EN-US_TOPIC_0000001917130460__b187927947">postPaid</strong>: pay-per-use billing. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001917130460__ul1761211359198"><li id="EN-US_TOPIC_0000001917130460__li1613035201914">Example normal response</li></ul>
<pre class="codeblock" id="EN-US_TOPIC_0000001917130460__codeblock583718106915">{
"instance": {
"id": "2gfdsh844a4023a776fc5c5fb71fb4in14",
"name": "gaussdb-instance-rep2",
"status": "BUILD",
"datastore": {
"type": "<span id="EN-US_TOPIC_0000001917130460__text796314146">GaussDB</span>",
"version": "1.4"
},
"ha": {
"mode": "enterprise",
"consistency": "strong",
"replication_mode": "sync"
},
"volume": {
"type": "ULTRAHIGH",
"size": 160
},
"port": "8000",
"replica_num": 3,
"region": "regionA",
"enable_parallel_restore": false,
"availability_zone": "aaa,bbb,ccc",
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
"charge_info": {
"charge_mode": "postPaid"
},
},
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}</pre>
<ul id="EN-US_TOPIC_0000001917130460__ul273517268209"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_li676912419816">Abnormal response<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917130460__en-us_topic_0128427213_li676912419816"></a><a name="en-us_topic_0128427213_li676912419816"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a>202</p>
</li><li id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130460__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917130460__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0025.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink