forked from docs/doc-exports
Ru, Li Yi
37b97ffc06
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>
114 lines
8.0 KiB
HTML
114 lines
8.0 KiB
HTML
<a name="nosql_05_0102"></a><a name="nosql_05_0102"></a>
|
|
|
|
<h1 class="topictitle1">Editing the Name of an Instance</h1>
|
|
<div id="body11523216172217"><div class="section" id="nosql_05_0102__section11524616102217"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0102__p165250166226">This API is used to edit the name of an instance.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0102__p3567737111013">This API supports GeminiDB Cassandra instances.</p>
|
|
<p id="nosql_05_0102__p174928344611">The name of the instance that is being created or fails to be created cannot be edited.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section165521516192212"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0102__p155536165221">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__table35583162222" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0102__row8555111622220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0102__p12558121610224">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0102__p85609163228">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_05_0102__p115611016132215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_05_0102__p1956361611221">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0102__row3555516162212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0102__p155641916152218">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0102__p75659162221">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0102__p856731618229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0102__p17568201613226">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_05_0102__row1055518164224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0102__p85697162226">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0102__p3571151618224">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0102__p1357291616223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0102__p1457481617223">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section18575141613229"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0102__row1057771613225"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0102__p1357918168225">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0102__p165811316172210">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0102__p258211692211">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0102__p3583416152216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0102__row3577616142214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__p752726193010">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__p2058631610224">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__p15588131618228">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__p15901316152217">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__request_UpdateInstanceNameRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0102__row115915165223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0102__p17593161632219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0102__p759581632211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_05_0102__p2059641682217">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_05_0102__p14599116162210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0102__row15591716142220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0102__p19601141682213">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0102__p186031816132211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0102__p1360501642211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0102__p56063165226">New instance name.</p>
|
|
<p id="nosql_05_0102__p15608516142212">The name:</p>
|
|
<p id="nosql_05_0102__p8610181612214">Must start with a letter and can include 4 to 64 characters. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section56112166225"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0102__p1231417042713"><strong id="nosql_05_0102__b194017251639">Status code: 204</strong></p>
|
|
<p id="nosql_05_0102__p1761341682219">No response parameters</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section561491619225"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0102__ul126161416102211"><li id="nosql_05_0102__li1612212299387">URI example<pre class="screen" id="nosql_05_0102__screen61231229183815">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name</pre>
|
|
</li><li id="nosql_05_0102__li562391632210">Changing the instance name to <strong id="nosql_05_0102__b7597113016124">myNewName</strong><pre class="screen" id="nosql_05_0102__screen562561612219">{
|
|
"name" : "myNewName"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section5629416132219"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0102__p363014169224">None</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0102__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0102__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0102__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|