forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
161 lines
14 KiB
HTML
161 lines
14 KiB
HTML
<a name="mrs_02_1087"></a><a name="mrs_02_1087"></a>
|
|
|
|
<h1 class="topictitle1">Checking the Login</h1>
|
|
<div id="body8662426"><div class="section" id="mrs_02_1087__en-us_topic_0125376217_section10164165933618"><h4 class="sectiontitle">Function </h4><p class="msonormal" id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p595879">This API is used to check the login after a login request is submitted.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_1087__en-us_topic_0125376217_s4ba458a90f404e0592cdbfb06cf206ee"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p54541350">GET /web/v1/access/login_check</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_1087__en-us_topic_0125376217_s047f3728c7ee421a915db3e28ae4d55e"><h4 class="sectiontitle">Request</h4><ul id="mrs_02_1087__en-us_topic_0125376217_ul36198363372"><li id="mrs_02_1087__en-us_topic_0125376217_li17619636193717">Example:<pre class="screen" id="mrs_02_1087__en-us_topic_0125376217_screen1980612574379">GET /web/v1/access/login_check HTTP/1.1
|
|
Host: example.com
|
|
Content-Type: application/json
|
|
Accept:application/json</pre>
|
|
</li><li class="msonormal" id="mrs_02_1087__en-us_topic_0125376217_li232615116397">Parameter description<p id="mrs_02_1087__en-us_topic_0125376217_p17699158163919"><a name="mrs_02_1087__en-us_topic_0125376217_li232615116397"></a><a name="en-us_topic_0125376217_li232615116397"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_1087__en-us_topic_0125376217_sede0e6eaeae5491f92e940a31873f285"><h4 class="sectiontitle">Response</h4><ul id="mrs_02_1087__en-us_topic_0125376217_ul058316824020"><li id="mrs_02_1087__en-us_topic_0125376217_li165831685407">Example:<pre class="screen" id="mrs_02_1087__en-us_topic_0125376217_screen143435713422">HTTP/1.1 200 OK
|
|
Data:Wed,02 May 2018 10:10:01 GMT
|
|
Server: example-server
|
|
Content-Type: application/json
|
|
{
|
|
"id": 0,
|
|
"state": "NEW",
|
|
"error_code": 0,
|
|
"error_description": "string",
|
|
"total_progress": 0,
|
|
"modify_pwd": true,
|
|
"exist_cluster": true,
|
|
"remind_pwd": true,
|
|
"ref_URL": "string"
|
|
"token": "string"
|
|
}</pre>
|
|
</li><li id="mrs_02_1087__en-us_topic_0125376217_li1684914102439">Response parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_table56762234" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row60536997"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.1.5.1.1"><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p4549718"><strong id="mrs_02_1087__b7617970162543">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.1.5.1.2"><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p32982843">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.1.5.1.3"><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p54364604"><strong id="mrs_02_1087__b144166711051221">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.4.3.1.5.1.4"><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p6068860"><strong id="mrs_02_1087__b842352706134712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row21815680"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p22239656">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p56581725">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p19716998">LONG</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p43359308">Asynchronous task ID (meaningless in other scenarios). The default value is <strong id="mrs_02_1087__b842352706191850">-1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row54689460"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p661272">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p53563101">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p43643947">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p32012887">Cluster status. The value <strong id="mrs_02_1087__b842352706191926">FAILED</strong> indicates that the command fails to be executed. The value <strong id="mrs_02_1087__b842352706191940">COMPLETE</strong> indicates that the command is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row19680527"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p50618827">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p6484348">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p55470218">INTEGER</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p36441454">Error code returned</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row59537635"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p57819120">error_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p52837125">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p51948747">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p47237200">Error code description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row22481618"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p9071785">total_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p63726013">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p61533429">FLOAT</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p43270153">Total progress</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row53887058"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p2775549">modify_pwd</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p23492921">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p23878445">BOOLEAN</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p34508910">Whether to change the password. The password does not need to be changed by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row42144734"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p58280312">exist_cluster</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p23084822">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p57931297">BOOLEAN</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p2734428">Whether a cluster exists</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row24609853"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p47241071">remind_pwd</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p1321529">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p39935044">BOOLEAN</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p8928760">Whether to remind the user to change the password</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_row13249979"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p66615359">ref_URL</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p27134992">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p50450709">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_en-us_topic_0110839910_p40687087">URL to be redirected </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1087__en-us_topic_0125376217_row6248447183218"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_p62481547133212">token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_p643512415335">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.1.5.1.3 "><p id="mrs_02_1087__en-us_topic_0125376217_p1724884717322">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.1.5.1.4 "><p id="mrs_02_1087__en-us_topic_0125376217_p824816477322">Token that is responded after login and check</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_1087__en-us_topic_0125376217_section2092982712508"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1087__en-us_topic_0125376217_table2979011121511" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1087__en-us_topic_0125376217_row3981161161515"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.2.1.3.1.1"><p id="mrs_02_1087__en-us_topic_0125376217_p398115116158">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="83%" id="mcps1.3.5.2.1.3.1.2"><p id="mrs_02_1087__en-us_topic_0125376217_p1798121191515">Description </p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1087__en-us_topic_0125376217_row69813112155"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.1.1 "><p id="mrs_02_1087__en-us_topic_0125376217_p15667142018546">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83%" headers="mcps1.3.5.2.1.3.1.2 "><p id="mrs_02_1087__en-us_topic_0125376217_p67110329349">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_1087__en-us_topic_0125376217_p385511715205">For details about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_1086.html">MRS Manager Web APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|