forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
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>
108 lines
12 KiB
HTML
108 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0000001947569645"></a><a name="EN-US_TOPIC_0000001947569645"></a>
|
|
|
|
<h1 class="topictitle1">Changing a DB Instance Name</h1>
|
|
<div id="body0000001206727829"><div class="section" id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p1779463834710">This API is used to change an instance name. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001947569645__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_0000001947569645__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_0000001947569645__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_0000001947569645__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>PUT https://{<em id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{<em id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_i8287192519110">project_id</em>}/instances/{<em id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_i575217298119">instance_id</em>}/name</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001947569645__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/dsfae23fsfdsae3435in14/name</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569645__li28384043417">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_table1986313483146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_row158631348151416"><th align="left" class="cellrowborder" valign="top" width="22.79%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p178635485145"><strong id="EN-US_TOPIC_0000001947569645__b3157232132813">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p586384819144"><strong id="EN-US_TOPIC_0000001947569645__b1616203392813">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.330000000000005%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p3863164871419"><strong id="EN-US_TOPIC_0000001947569645__b871164072812">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569645__row153821619455"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427214_p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427214_p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569645__p19528455451">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001947569645__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569645__row103812684518"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427214_p1046217474614">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427214_p246284104619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569645__p2201242204518">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_li387592375220">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_table477719232522" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_row118759235520"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p1587542375213"><strong id="EN-US_TOPIC_0000001947569645__b56329542284">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p287512375212"><strong id="EN-US_TOPIC_0000001947569645__b19693195592814">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p8875152313526"><strong id="EN-US_TOPIC_0000001947569645__b145531356142818">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.76%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p198753239523"><strong id="EN-US_TOPIC_0000001947569645__b1597310590289">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_row1387582319526"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p9875523185210">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_p168751823115220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0151958051_a9a9492e05cb648e885d1e747a339d04d">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569645__p23411412333">DB instance name. Instances of the same type can have same names under the same tenant.</p>
|
|
<p id="EN-US_TOPIC_0000001947569645__p61847473">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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569645__section1255613104515"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000001947569645__p1395112812199">Changing a DB instance name<pre class="screen" id="EN-US_TOPIC_0000001947569645__screen3543147144511">{
|
|
"name": "instance-name"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_section415313301118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_ul187991238144718"><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li10799193816479">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_table668693854710" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_row579917386473"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p11799738114718"><strong id="EN-US_TOPIC_0000001947569645__b1629513496294">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p879983818477"><strong id="EN-US_TOPIC_0000001947569645__b55631850112918">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p1799538174710"><strong id="EN-US_TOPIC_0000001947569645__b1516019531299">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_row1379923812473"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p5799103874712">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p879983854715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_p177991438194711">Task ID for changing an instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li735719919138">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_codeblock053262517133">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001947569645__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001947569645__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569645__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>202</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001947569645__en-us_topic_0110967248_li11583183218149"></a><a name="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_0000001947569645__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001947569645__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_0014.html">Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|