doc-exports/docs/opengauss/api-ref/opengauss_api_0021.html
Ru, Li Yi d97aea4dd2 opengauss_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-09-06 09:04:21 +00:00

89 lines
11 KiB
HTML

<a name="EN-US_TOPIC_0000001917290428"></a><a name="EN-US_TOPIC_0000001917290428"></a>
<h1 class="topictitle1">Resetting a Database Password</h1>
<div id="body0000001207049281"><div class="section" id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_p1779463834710">This API is used to reset a database password. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917290428__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290428__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_0000001917290428__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_0000001917290428__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_0000001917290428__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>POST https://{<em id="EN-US_TOPIC_0000001917290428__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{<em id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_i8287192519110">project_id</em>}/instances/{<em id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_i575217298119">instance_id</em>}/password</p>
</li><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001917290428__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/dsfae23fsfdsae3435in01/password</p>
</li><li id="EN-US_TOPIC_0000001917290428__li1953314012334">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290428__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_0000001917290428__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_0000001917290428__en-us_topic_0248254028_p178635485145"><strong id="EN-US_TOPIC_0000001917290428__b5504115518252">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_0000001917290428__en-us_topic_0248254028_p586384819144"><strong id="EN-US_TOPIC_0000001917290428__b1952045618252">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_0000001917290428__en-us_topic_0248254028_p3863164871419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290428__row10566131981211"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290428__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_0000001917290428__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_0000001917290428__p137165394126">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917290428__p671623981213">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290428__row1565619141219"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290428__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_0000001917290428__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_0000001917290428__p1881394218125">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290428__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001917290428__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0151958051_li387592375220">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290428__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_0000001917290428__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_0000001917290428__en-us_topic_0151958051_p1587542375213"><strong id="EN-US_TOPIC_0000001917290428__b9329910132619">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_0000001917290428__en-us_topic_0151958051_p287512375212"><strong id="EN-US_TOPIC_0000001917290428__b6376611132618">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_0000001917290428__en-us_topic_0151958051_p8875152313526"><strong id="EN-US_TOPIC_0000001917290428__b1931841213262">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_0000001917290428__en-us_topic_0151958051_p198753239523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290428__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_0000001917290428__en-us_topic_0151958051_p9875523185210">password</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_0000001917290428__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_0000001917290428__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_0000001917290428__p23411412333">Password for user <strong id="EN-US_TOPIC_0000001917290428__b118291719260">root</strong>. The password must:</p>
<ul id="EN-US_TOPIC_0000001917290428__ul23831659193214"><li id="EN-US_TOPIC_0000001917290428__li8383159193216">Consist of 8 to 32 characters.</li><li id="EN-US_TOPIC_0000001917290428__li71851717173614">Contain at least three types of the following characters:<p id="EN-US_TOPIC_0000001917290428__p171841617193620"><a name="EN-US_TOPIC_0000001917290428__li71851717173614"></a><a name="li71851717173614"></a>Uppercase letters, lowercase letters, digits, and special characters (~! @# %^*-_=+?,)</p>
</li><li id="EN-US_TOPIC_0000001917290428__li14383195973213">Support weak password verification.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290428__section95722436447"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000001917290428__p1037781013187">Changing the password of user <strong id="EN-US_TOPIC_0000001917290428__b318341214189">root</strong><pre class="screen" id="EN-US_TOPIC_0000001917290428__screen13496238184411">{
"password": "******"
}</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_section415313301118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290428__ul31923327101549"><li id="EN-US_TOPIC_0000001917290428__li18874490101549">Normal response<p id="EN-US_TOPIC_0000001917290428__p7836161173816"><a name="EN-US_TOPIC_0000001917290428__li18874490101549"></a><a name="li18874490101549"></a>None</p>
</li><li id="EN-US_TOPIC_0000001917290428__li27619632">Example normal response<p id="EN-US_TOPIC_0000001917290428__p910118291344"><a name="EN-US_TOPIC_0000001917290428__li27619632"></a><a name="li27619632"></a>{}</p>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001917290428__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917290428__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_0000001917290428__en-us_topic_0248254028_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0256709922_en-us_topic_0110967248_li58581622171411"></a>200</p>
</li><li id="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290428__en-us_topic_0256709922_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0256709922_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_0000001917290428__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290428__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>