forked from docs/doc-exports
Wang , Deng Ke
60010eb9d0
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
83 lines
6.5 KiB
HTML
83 lines
6.5 KiB
HTML
<a name="dds_api_0053"></a><a name="dds_api_0053"></a>
|
|
|
|
<h1 class="topictitle1">Modifying a DB Instance Name</h1>
|
|
<div id="body1540173589336"><div class="section" id="dds_api_0053__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0053__p3631239417316">This API is used to modify a DB instance name.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section1239972118494"><h4 class="sectiontitle">Constraints</h4><p id="dds_api_0053__p1064515261517">The name of the DB instance that is being created or fails to be created cannot be modified.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0053__ul3084351717316"><li id="dds_api_0053__li915620217316">URI format<p id="dds_api_0053__p912862005412"><a name="dds_api_0053__li915620217316"></a><a name="li915620217316"></a>PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name</p>
|
|
</li><li id="dds_api_0053__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0053__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0053__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0053__p34889605">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0053__p7485743">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0053__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0053__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0053__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0053__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0053__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0053__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0053__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0053__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0053__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0053__ul5099287616954"><li id="dds_api_0053__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0053__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0053__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0053__p1204887716954">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0053__p15184124818564">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0053__p3643495116954">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.43434343434344%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0053__p222501215320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0053__row794180116954"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0053__p1893915195211">new_instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0053__p10939185185210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0053__p189393585216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0053__p993995165218">Specifies the DB instance name. The instance name can be the same as an existing instance name.</p>
|
|
<ul id="dds_api_0053__ul1444173811511"><li id="dds_api_0053__li9441138195114">The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0053__ul1041877316954"><li id="dds_api_0053__li2666010016954">Example request<div class="p" id="dds_api_0053__p15333141451019"><a name="dds_api_0053__li2666010016954"></a><a name="li2666010016954"></a>PUT https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name<pre class="codeblock" id="dds_api_0053__codeblock1053211321015">{
|
|
"new_instance_name": "myNewName"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0053__ul16665627"><li id="dds_api_0053__li15772917">Response example<pre class="codeblock" id="dds_api_0053__codeblock660937479172">{}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0053__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0053__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0053__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0053__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|