Yang, Tong bd2b57f749 MRS API 2.0.38.SP20 version

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>

2022-11-16 15:06:08 +00:00

14 KiB

Raw Permalink Blame History

Checking the Login

Function

This API is used to check the login after a login request is submitted.

URI

GET /web/v1/access/login_check

Request

Example:

GET /web/v1/access/login_check HTTP/1.1
Host: example.com
Content-Type: application/json
Accept:application/json

Parameter description
None

Response

Example:

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"
}

Response parameter description

Parameter	Mandatory or Not	Type	Description
id	No	LONG	Asynchronous task ID (meaningless in other scenarios). The default value is -1.
state	No	STRING	Cluster status. The value FAILED indicates that the command fails to be executed. The value COMPLETE indicates that the command is successfully executed.
error_code	No	INTEGER	Error code returned
error_description	No	STRING	Error code description
total_progress	No	FLOAT	Total progress
modify_pwd	No	BOOLEAN	Whether to change the password. The password does not need to be changed by default.
exist_cluster	No	BOOLEAN	Whether a cluster exists
remind_pwd	No	BOOLEAN	Whether to remind the user to change the password
ref_URL	No	STRING	URL to be redirected
token	No	STRING	Token that is responded after login and check

Status Code

Status Code	Description
200	The operation is successful.

For details about error status codes, see Status Codes.

Parent topic: MRS Manager Web APIs

14 KiB Raw Permalink Blame History

Checking the Login

Function

URI

Request

Response

Status Code

14 KiB

Raw Permalink Blame History