yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/rds/api-ref/rds_05_0029.html
wangdengke2 1ddaec1a62 rds_api 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-01-29 11:28:26 +00:00

144 lines
12 KiB
HTML
Raw Blame History

<a name="rds_05_0029"></a><a name="rds_05_0029"></a>
<h1 class="topictitle1">Changing the Description of a DB Instance</h1>
<div id="body0000002506575379"><div class="section" id="rds_05_0029__en-us_topic_0293125646_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_05_0029__en-us_topic_0293125646_p5753583532">This API is used to change the description of a DB instance.</p>
<ul id="rds_05_0029__en-us_topic_0293125646_ul12259155218373"><li id="rds_05_0029__en-us_topic_0293125646_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_05_0029__en-us_topic_0293125646_en-us_topic_0110967248_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_05_0029__en-us_topic_0293125646_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0029__en-us_topic_0293125646_ul53354139141429"><li id="rds_05_0029__en-us_topic_0293125646_li1270098217262">URI format<p id="rds_05_0029__en-us_topic_0293125646_p66079617141421"><a name="rds_05_0029__en-us_topic_0293125646_li1270098217262"></a><a name="en-us_topic_0293125646_li1270098217262"></a>PUT https://{<em id="rds_05_0029__en-us_topic_0293125646_i86129260155">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/alias</p>
</li></ul>
<ul id="rds_05_0029__en-us_topic_0293125646_ul49831254144655"><li id="rds_05_0029__en-us_topic_0293125646_li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0029__en-us_topic_0293125646_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0029__en-us_topic_0293125646_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.979999999999997%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_05_0029__en-us_topic_0293125646_p34889605">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.55%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_05_0029__en-us_topic_0293125646_p7485743">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_05_0029__en-us_topic_0293125646_p2365466">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0029__en-us_topic_0293125646_row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_05_0029__en-us_topic_0293125646_p17679057">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_05_0029__en-us_topic_0293125646_p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_05_0029__en-us_topic_0293125646_p28182251">Specifies the project ID of a tenant in a region.</p>
<p id="rds_05_0029__en-us_topic_0293125646_p181691757183820">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="rds_05_0029__en-us_topic_0293125646_row2864326155157"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_05_0029__en-us_topic_0293125646_p41557789155220">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_05_0029__en-us_topic_0293125646_p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_05_0029__en-us_topic_0293125646_p981962520456">Specifies the DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_05_0029__en-us_topic_0293125646_section3074340117316"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0029__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_05_0029__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.2.5.1.1"><p id="rds_05_0029__p95111733143318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.2.5.1.2"><p id="rds_05_0029__p13511123373311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.2.5.1.3"><p id="rds_05_0029__p125111433133312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.2.5.1.4"><p id="rds_05_0029__p551110331335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0029__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_05_0029__p18511533163317">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_05_0029__p13511153333312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_05_0029__p55111833183319">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_05_0029__p35111331332">The content type.</p>
<p id="rds_05_0029__p1351133311330">The default value is <strong id="rds_05_0029__b105111133143310">application/json</strong>.</p>
</td>
</tr>
<tr id="rds_05_0029__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.2.5.1.1 "><p id="rds_05_0029__p1163015550331">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="rds_05_0029__p1963035563316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="rds_05_0029__p1630105520331">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.2.5.1.4 "><p id="rds_05_0029__p1086851153317">Specifies the user token.</p>
<p id="rds_05_0029__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0029__en-us_topic_0293125646_table11236435" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0029__en-us_topic_0293125646_row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.3.3.2.5.1.1"><p id="rds_05_0029__en-us_topic_0293125646_p17490046">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.3.3.2.5.1.2"><p id="rds_05_0029__en-us_topic_0293125646_p7407659">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.3.3.2.5.1.3"><p id="rds_05_0029__en-us_topic_0293125646_p63149496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.3.3.2.5.1.4"><p id="rds_05_0029__en-us_topic_0293125646_p14835533">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0029__en-us_topic_0293125646_row60827539"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rds_05_0029__p28083633">alias</p>
</td>
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rds_05_0029__p60181840">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rds_05_0029__p42890904">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rds_05_0029__p13882179385">The value consists of 0 to 64 characters, including letters, digits, periods (.), underscores (_), and hyphens (-).</p>
<p id="rds_05_0029__p7279193910107">If this parameter is not specified or is set to null, the original description of the instance will be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rds_05_0029__section244651402914"><h4 class="sectiontitle">Example Request</h4><p id="rds_05_0029__p11607139102216">Change the description of a DB instance.</p>
<pre class="screen" id="rds_05_0029__screen205656142213">PUT https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/alias
{
"alias": "alias-test"
}</pre>
</div>
<div class="section" id="rds_05_0029__en-us_topic_0293125646_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0029__en-us_topic_0293125646_ul12573920"><li id="rds_05_0029__en-us_topic_0293125646_li46056421">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0029__table32267243" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0029__row9230088"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_05_0029__p9439626"><strong id="rds_05_0029__b1050411334269">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_05_0029__p26412257"><strong id="rds_05_0029__b15478181792010">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_05_0029__p59018101"><strong id="rds_05_0029__b1616131902012">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0029__row15736877"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0029__p66727538">resp</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0029__p36221483">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0029__p48259009">Returns <strong id="rds_05_0029__b687141992011">successful</strong> if the invoking is successful.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="rds_05_0029__en-us_topic_0293125646_ul16665627"><li id="rds_05_0029__en-us_topic_0293125646_li15772917">Example normal response<pre class="screen" id="rds_05_0029__screen128992373368">{
"resp": "successful"
}</pre>
</li></ul>
<ul id="rds_05_0029__en-us_topic_0293125646_ul26818564"><li id="rds_05_0029__en-us_topic_0293125646_li33014451514">Abnormal response<p id="rds_05_0029__en-us_topic_0293125646_en-us_topic_0110967248_p014165512396"><a name="rds_05_0029__en-us_topic_0293125646_li33014451514"></a><a name="en-us_topic_0293125646_li33014451514"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="rds_05_0029__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0029__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0029__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0029__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0029__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_05_0029__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0029__en-us_topic_0032347778_p0723374409"><a name="rds_05_0029__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_05_0029__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0029__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>
View Git Blame Copy Permalink