forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
179 lines
14 KiB
HTML
179 lines
14 KiB
HTML
<a name="dcs-api-0312019"></a><a name="dcs-api-0312019"></a>
|
|
|
|
<h1 class="topictitle1">Changing the Password of a DCS Instance</h1>
|
|
<div id="body689026"><div class="section" id="dcs-api-0312019__section624561415814"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312019__p18781101713811">This API is used to change the password of a DCS instance.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312019__section10627123311133"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312019__p166381149581">PUT /v1.0/{project_id}/instances/{instance_id}/password</p>
|
|
<div class="p" id="dcs-api-0312019__p939123033811"><a href="#dcs-api-0312019__table1899262913382">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312019__table1899262913382"></a><a name="table1899262913382"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312019__table1899262913382" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312019__row1599115293389"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312019__p15991152913819">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312019__p129916298387">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312019__p13991142913384">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312019__p1991329193814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312019__row11992929163813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312019__p159911329153817">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312019__p18992192943819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312019__p9992172933814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312019__p20992829103811">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row17992929193810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312019__p1899282919384">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312019__p15992229153810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312019__p199921129133818">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312019__p199212910384">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312019__section17412144620133"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="dcs-api-0312019__p036841715408"><strong id="dcs-api-0312019__b201392039474">Request parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312019__p9769133510383"><a href="#dcs-api-0312019__table153111335113816">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312019__table153111335113816"></a><a name="table153111335113816"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312019__table153111335113816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312019__row73117359383"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312019__p1031043517387">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312019__p19310113593814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312019__p93101035183813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312019__p173101235153817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312019__row1631133513386"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312019__p15311153513819">old_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312019__p83117356388">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312019__p14311153513817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312019__p93111435193817">Old password.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row1231173523817"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312019__p163111355384">new_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312019__p11311153518384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312019__p53111335163815">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312019__p1151217611544">New password.</p>
|
|
<p id="dcs-api-0312019__p142316116477">Password complexity requirements:</p>
|
|
<ul id="dcs-api-0312019__ul12231151134714"><li id="dcs-api-0312019__li22311111174712">Cannot be empty.</li><li id="dcs-api-0312019__li12143853193718">Cannot be the username or the username spelled backwards.</li><li id="dcs-api-0312019__li13231161174719">Can be 8 to 32 characters long.</li><li id="dcs-api-0312019__li723118111478">Contain at least three of the following character types:<ul id="dcs-api-0312019__ul923141104715"><li id="dcs-api-0312019__li1423171124710">Lowercase letters</li><li id="dcs-api-0312019__li6231131174713">Uppercase letters</li><li id="dcs-api-0312019__li16231311144720">Digits</li><li id="dcs-api-0312019__li4231201111475">Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312019__p18178425164011"><strong id="dcs-api-0312019__b20528354074">Example request</strong></p>
|
|
<ul id="dcs-api-0312019__ul517935720231"><li id="dcs-api-0312019__li617925719234">Request URL:<pre class="screen" id="dcs-api-0312019__screen27641332171017">PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password</pre>
|
|
</li></ul>
|
|
<ul id="dcs-api-0312019__ul133024119241"><li id="dcs-api-0312019__li730216142420">Example:<pre class="screen" id="dcs-api-0312019__screen13274335164015">{
|
|
"old_password": "XXXXXX",
|
|
"new_password": "XXXXXX"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312019__section1417213312142"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312019__p193854910404"><strong id="dcs-api-0312019__b03438017814">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312019__p1799214576389"><a href="#dcs-api-0312019__table1861319576383">Table 3</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312019__table1861319576383"></a><a name="table1861319576383"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312019__table1861319576383" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312019__row1961225712388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312019__p136126577389">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312019__p76121757113816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312019__p26121157123820">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312019__row166121557203812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312019__p661215713816">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312019__p1361217571386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312019__p161215718387">An indicator of whether the password is successfully changed: Options:</p>
|
|
<ul id="dcs-api-0312019__ul961213577385"><li id="dcs-api-0312019__li26126574383"><strong id="dcs-api-0312019__b93281455124114">Success</strong>: Password changed successfully.</li><li id="dcs-api-0312019__li2612115773810"><strong id="dcs-api-0312019__b1620084214">passwordFailed</strong>: The old password is incorrect.</li><li id="dcs-api-0312019__li106124572384"><strong id="dcs-api-0312019__b571619834211">Locked</strong>: This account has been locked.</li><li id="dcs-api-0312019__li196121657103812"><strong id="dcs-api-0312019__b9782141304213">Failed</strong>: Failed to change the password.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row11613175783810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312019__p1661215710381">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312019__p20613957153810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312019__p13613165713818">Result of password change.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row1861345773818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312019__p146132571380">retry_times_left</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312019__p1693410516476">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312019__p36131657153819">Number of remaining password attempts. If the old password is incorrect, the value of this parameter is not <strong id="dcs-api-0312019__b1744113279352">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row156131057123818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312019__p156132057163817">lock_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312019__p1393235114720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312019__p261395712388">Account lockout duration. If the old password is incorrect or the account is locked, the value of this parameter is not <strong id="dcs-api-0312019__b298819137386">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312019__row1961385710387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312019__p1961345733810">lock_time_left</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312019__p8927551114720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312019__p13613105783815">Remaining time before the account is unlocked. If the account is locked, the value of this parameter is not <strong id="dcs-api-0312019__b1483134414398">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312019__p279219520416"><strong id="dcs-api-0312019__b153971091889">Example response</strong><pre class="screen" id="dcs-api-0312019__screen18861710144112">//Change password success.
|
|
{
|
|
"result" : "Success",
|
|
"message" : "Modify DCSInstance password success.",
|
|
"retry_times_left" : "5",
|
|
"lock_time" : "0",
|
|
"lock_time_left" : "0"
|
|
}
|
|
//Change password failed.
|
|
{
|
|
"result" : "passwordFailed",
|
|
"message" : "verify password failed.",
|
|
"retry_times_left" : "4",
|
|
"lock_time" : "5",
|
|
"lock_time_left" : "5"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312019__section4860101417132"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312019__p586081451311"><a href="#dcs-api-0312019__table486141410130">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312019__table486141410130"></a><a name="table486141410130"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312019__table486141410130" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312019__row18616141139"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312019__p1986191418133">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312019__p18861111415138">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312019__row786131451312"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312019__p6861114181311">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312019__p48619143136">Password changed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312035.html">Instance Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|