yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
ac787f42f1e2d2e611f07a75624c4380a68149aa
doc-exports/docs/dcs/api-ref/UpdatePassword.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

248 lines
18 KiB
HTML
Raw Blame History

<a name="UpdatePassword"></a><a name="UpdatePassword"></a>
<h1 class="topictitle1">Changing the Password</h1>
<div id="body1708331107508"><div class="section" id="UpdatePassword__section1658714933219"><h4 class="sectiontitle">Function</h4><p id="UpdatePassword__p758712498327">This API is used to change the password of a DCS instance.</p>
</div>
<div class="section" id="UpdatePassword__section125874496329"><h4 class="sectiontitle">URI</h4><p id="UpdatePassword__p20587174963210">PUT /v2/{project_id}/instances/{instance_id}/password</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__table75876498327" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdatePassword__row1658794910328"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdatePassword__p4588104933213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdatePassword__p25884495324">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdatePassword__p158804973213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdatePassword__p13588194953216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row7587449103219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePassword__p0588114993215">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePassword__p058874914326">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePassword__p17588144910321">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePassword__p658804913329">Instance ID.</p>
</td>
</tr>
<tr id="UpdatePassword__row858734913213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePassword__p358854919323">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePassword__p15588104993213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePassword__p11588149123211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePassword__p758884943217">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePassword__section1758816491322"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__request_ModifyInstancePasswordBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdatePassword__row7589144943211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdatePassword__p185897499329">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdatePassword__p85892499329">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdatePassword__p17589849133219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdatePassword__p9589154913211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row1589949143216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdatePassword__p958914913211">old_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdatePassword__p145891949183213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdatePassword__p8589249143217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdatePassword__p558920498322">Old password.</p>
</td>
</tr>
<tr id="UpdatePassword__row145891049173214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdatePassword__p19589449123210">new_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdatePassword__p858994913212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdatePassword__p19590649183217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdatePassword__p115902049133210">New password.</p>
<p id="UpdatePassword__p18638548114014">The password of a DCS Redis instance must meet the following complexity requirements:</p>
<ul id="UpdatePassword__ul2093015489325"><li id="UpdatePassword__li093064803214">Can contain 8 to 32 characters.</li><li id="UpdatePassword__li1093016488325">The new password must be different from the old password.</li><li id="UpdatePassword__li1293013483323">Must contain at least three of the following character types:<ul id="UpdatePassword__ul139302487325"><li id="UpdatePassword__li13930174810328">Lowercase letters</li><li id="UpdatePassword__li109306484323">Uppercase letters</li><li id="UpdatePassword__li193154814327">Digits</li><li id="UpdatePassword__li19314485325">Special characters `~!@#$^&amp;*()-_=+\|{},&lt;.&gt;/?</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePassword__section35901249183217"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdatePassword__p195905498324"><strong id="UpdatePassword__b0590949183213">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__response_ModifyInstancePasswordResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="UpdatePassword__row155909498323"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdatePassword__p10590949103219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdatePassword__p10590134913325">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdatePassword__p259017499321">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row1459064963217"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePassword__p759114983210">lock_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePassword__p1859164917326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePassword__p20591114915329">Lock duration, in minutes. If the authentication fails and the account is locked, a response is returned and is not <strong id="UpdatePassword__b17591134918326">null</strong>.</p>
<p id="UpdatePassword__p34015185114">During password modification, after 5 failed password attempts, the instance will be locked and the password cannot be changed or reset for 5 minutes.</p>
</td>
</tr>
<tr id="UpdatePassword__row1590114973211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePassword__p35911949113217">result</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePassword__p155916494326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePassword__p16591149163215">Password change result:</p>
<ul id="UpdatePassword__ul155911249153213"><li id="UpdatePassword__li3591349173210"><strong id="UpdatePassword__b159116491323">success</strong>: Password is changed successfully.</li><li id="UpdatePassword__li5591249133214"><strong id="UpdatePassword__b1459124916321">passwordFailed</strong>: Password authentication failed.</li><li id="UpdatePassword__li165916497328"><strong id="UpdatePassword__b259194963213">locked</strong>: The account has been locked.</li><li id="UpdatePassword__li4591749193218"><strong id="UpdatePassword__b1859118497329">failed</strong>: Password change failed.</li></ul>
</td>
</tr>
<tr id="UpdatePassword__row1590649143216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePassword__p15911049133215">lock_time_left</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePassword__p1059134912324">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePassword__p12591124919327">Remaining time before the account is unlocked, in minutes. When the account is locked, a response is returned and is not <strong id="UpdatePassword__b1359204910324">null</strong>.</p>
</td>
</tr>
<tr id="UpdatePassword__row205909496323"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePassword__p1059204993212">retry_times_left</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePassword__p135924491321">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePassword__p0592164913323">Number of remaining password attempts. If the authentication fails, a response is returned and is not <strong id="UpdatePassword__b11592749163216">null</strong>.</p>
</td>
</tr>
<tr id="UpdatePassword__row059064916329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePassword__p1759254920322">message</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePassword__p459216497324">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePassword__p25922496325">Modification result description.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdatePassword__p195921249123218"><strong id="UpdatePassword__b11592124933219">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdatePassword__row1959210492324"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdatePassword__p959274953219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdatePassword__p205921849123217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdatePassword__p12593104916329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row1559274913220"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePassword__p559354913211">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePassword__p12593184911327">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePassword__p45935499321">Error message.</p>
</td>
</tr>
<tr id="UpdatePassword__row185921449103210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePassword__p16593124914326">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePassword__p1359384983210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePassword__p359312492322">Error code.</p>
</td>
</tr>
<tr id="UpdatePassword__row7592144913321"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePassword__p12593549133217">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePassword__p859310493325">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePassword__p175931549173215">Extended error information. This parameter is not used currently and is set to <strong id="UpdatePassword__b175937496322">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdatePassword__p55935491328"><strong id="UpdatePassword__b859344973210">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__table15939491323" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdatePassword__row6593124914325"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdatePassword__p155941049193212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdatePassword__p12594174911323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdatePassword__p115944497326">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row2593164912322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePassword__p145943490321">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePassword__p8594124993218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePassword__p15594134915325">Error message.</p>
</td>
</tr>
<tr id="UpdatePassword__row135931049193220"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePassword__p65941849173213">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePassword__p15941749123216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePassword__p859418492328">Error code.</p>
</td>
</tr>
<tr id="UpdatePassword__row7593949143213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePassword__p1359417496320">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePassword__p559417495322">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePassword__p5594164919322">Extended error information. This parameter is not used currently and is set to <strong id="UpdatePassword__b85941449153220">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePassword__section1959412497324"><h4 class="sectiontitle">Example Requests</h4><p id="UpdatePassword__p6594184916329">Changing the password of the DCS instance by entering the old and new passwords</p>
<pre class="screen" id="UpdatePassword__screen205952497327">PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password
{
"old_password" : "XXXXXX",
"new_password" : "XXXXXX"
}</pre>
</div>
<div class="section" id="UpdatePassword__section25951749113219"><h4 class="sectiontitle">Example Responses</h4><p id="UpdatePassword__p165955492327"><strong id="UpdatePassword__b359512491328">Status code: 200</strong></p>
<p id="UpdatePassword__p1859564919321">Password is changed successfully.</p>
<pre class="screen" id="UpdatePassword__screen125951649123211">{
"lock_time" : "0",
"result" : "success",
"lock_time_left" : "0",
"retry_times_left" : "5",
"message" : "Modify DCSInstance password success."
}</pre>
</div>
<div class="section" id="UpdatePassword__section1059674983212"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePassword__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdatePassword__row95961249153218"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdatePassword__p5596124993212">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdatePassword__p1259644943220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePassword__row7596149123212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePassword__p8596124918328">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePassword__p1359664916324">Password is changed successfully.</p>
</td>
</tr>
<tr id="UpdatePassword__row19596949163214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePassword__p7596449153215">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePassword__p95961049163218">Invalid request.</p>
</td>
</tr>
<tr id="UpdatePassword__row55967493328"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePassword__p125963499328">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePassword__p8596194933218">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePassword__section55961449163215"><h4 class="sectiontitle">Error Codes</h4><p id="UpdatePassword__p12597124973213">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="InstanceManagement.html">Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink