vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_05_0101.html
Ru, Li Yi 37b97ffc06 geminidb_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-07-04 11:26:33 +00:00

116 lines
8.4 KiB
HTML
Raw Blame History

<a name="nosql_05_0101"></a><a name="nosql_05_0101"></a>
<h1 class="topictitle1">Resetting the Administrator Password of an Instance</h1>
<div id="body18871912111610"><div class="section" id="nosql_05_0101__section14883121167"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0101__p7911412131618">This API is used to reset the administrator password of an instance.</p>
</div>
<div class="section" id="nosql_05_0101__section1239972118494"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0101__p3567737111013">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_05_0101__p19996168945">Abnormal instances do not support this operation.</p>
<p id="nosql_05_0101__p948312111245">Only the password of user <strong id="nosql_05_0101__b8111101116117">rwuser</strong> can be reset.</p>
</div>
<div class="section" id="nosql_05_0101__section151481412201611"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0101__p91516121164">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__table1715791221619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0101__row1615471261612"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0101__p161591812121615">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_0101__p316261261612">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_0101__p1216471211610">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_0101__p1116761231610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0101__row915419128161"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0101__p5170101241616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0101__p161731612101620">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0101__p15175112121615">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0101__p1517818128169">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_0101__row1154112111613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0101__p5180101211619">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0101__p1118317128165">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0101__p17185171291615">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0101__p1118881201617">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0101__section81917128167"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0101__row3194812151611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0101__p2019818127162">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_0101__p120112127169">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_0101__p32031512111613">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_0101__p1720721212168">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0101__row1319410124169"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__p52091512111614">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_0101__p12121312121615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__p0214151217166">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__p0217161218165">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__request_ResetPasswordRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0101__row1821941211162"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0101__p32240128169">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_0101__p82261212181613">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_0101__p192283124162">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_0101__p62311212101615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0101__row14219112111618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0101__p152341612111617">password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0101__p023621216161">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0101__p623910128163">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0101__p824211241618">Database password.</p>
<p id="nosql_05_0101__p1244111210161">The password can include 8 to 32 characters and contain uppercase letters, lowercase letters, digits, and a combination of any two of the following special characters: ~!@#%^*-_=+? </p>
<p id="nosql_05_0101__p0246181201612">Enter a strong password against security risks such as brute force cracking.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0101__section1624981215168"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0101__p4253171210166"><strong id="nosql_05_0101__b1835816141812">Status code: 204</strong></p>
<p id="nosql_05_0101__p125651291588">No response parameters</p>
</div>
<div class="section" id="nosql_05_0101__section5255191221618"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0101__ul32585125163"><li id="nosql_05_0101__li15613018366">URI example<pre class="screen" id="nosql_05_0101__screen5561209366">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password</pre>
</li><li id="nosql_05_0101__li15273161217166">Resetting the administrator password of an instance to <strong id="nosql_05_0101__b190971871211">******</strong><pre class="screen" id="nosql_05_0101__screen172760126164">{
"password" : "******"
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0101__section2284161214169"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0101__p11474136151119"><strong id="nosql_05_0101__b136821620131816">Status code: 204</strong></p>
<p id="nosql_05_0101__p647612364111">No Content</p>
</div>
<div class="section" id="nosql_05_0101__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0101__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0101__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0101__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>
View Git Blame Copy Permalink