使用账户身份登录

PUT/zstack/v1/accounts/login

Request

cURL

curl --request PUT \
  --url '/v1/accounts/login' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/accounts/login"
}

Body

{
  "logInByAccount": {
    "accountName": "test",
    "password": "password",
    "captchaUuid": "39bd748906ad301793c64f688dc197a9",
    "verifyCode": "test"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"logInByAccount":{"accountName":"test","password":"password","captchaUuid":"39bd748906ad301793c64f688dc197a9","verifyCode":"test"}}' \
http://localhost:8080/zstack/v1/accounts/login

参数列表

名字	类型	位置	描述	起始版本
accountName	String	body(包含在logInByAccount结构中)	账户名称	0.6
password	String	body(包含在logInByAccount结构中)	密码	0.6
captchaUuid (可选)	String	body(包含在logInByAccount结构中)	验证码UUID	2.6.0
verifyCode (可选)	String	body(包含在logInByAccount结构中)	验证码	2.6.0
clientInfo (可选)	Map	body(包含在logInByAccount结构中)	客户端信息	3.5.0
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6
accountType (可选)	String	body(包含在`logInByAccount`结构中)		3.4.0

API返回

返回示例

{
  "inventory": {
    "uuid": "5d77893e242d39ec8b9856a7b8762eab",
    "accountUuid": "7ab57f322e4a396b8124ed4fda810966",
    "expiredDate": "Nov 14, 2017 2:20:57 PM",
    "noSessionEvaluation": false
  }
}

名字	类型	描述	起始版本
success	boolean		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	SessionInventory	详情参考inventory	0.6

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
accountUuid	String	账户UUID	0.6
userUuid	String	用户UUID	0.6
expiredDate	Timestamp	会话过期日期	0.6
createDate	Timestamp	创建时间	0.6

SDK示例

Java SDK

LogInByAccountAction action = new LogInByAccountAction();
action.accountName = "test";
action.password = "password";
action.captchaUuid = "39bd748906ad301793c64f688dc197a9";
action.verifyCode = "test";
LogInByAccountAction.Result res = action.call();

Python SDK

LogInByAccountAction action = LogInByAccountAction()
action.accountName = "test"
action.password = "password"
action.captchaUuid = "39bd748906ad301793c64f688dc197a9"
action.verifyCode = "test"
LogInByAccountAction.Result res = action.call()