获取登录验证码

GET/zstack/v1/login/control/captcha

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" -X GET http://localhost:8080/zstack/v1/login/control/captcha?resourceName=admin&loginType=Test

参数列表

名字	类型	位置	描述	起始版本
resourceName	String	query	资源名称	2.6.0
loginType	String	query	登录类型	2.6.0
systemTags (可选)	List	query	系统标签	2.6.0
userTags (可选)	List	query	用户标签	2.6.0
captchaUuid (可选)	String	query		0.6

API返回

返回示例

{
  "captchaUuid": "ff0c9fd9ea99333aa9f47cf61b5f0900",
  "captcha": "test"
}

名字	类型	描述	起始版本
captchaUuid	String	验证码的唯一标识符	2.6.0
captcha	String	验证码图片的base64形式	2.6.0
success	boolean		2.6.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.6.0

error

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

SDK示例

Java SDK

GetLoginCaptchaAction action = new GetLoginCaptchaAction();
action.resourceName = "admin";
action.loginType = "Test";
GetLoginCaptchaAction.Result res = action.call();

Python SDK

action = GetLoginCaptchaAction()
action.resourceName = "admin"
action.loginType = "Test"
res = action.call()