跳转到主要内容
ZStack
设置/用户管理相关接口

使用账户身份登录

使用账户身份登录

PUT/zstack/v1/accounts/login

操作 ID

LogInByAccount

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • accountName
    String必填

    账户名称Note: 账户名称和账户UUID不能同时为空

  • password
    String必填

    密码

  • captchaUuid
    String

    验证码UUID

  • verifyCode
    String

    验证码

  • clientInfo
    Map

    客户端信息

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    SessionInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • accountUuid
      String必填

      账户UUID

    • userUuid
      String必填

      用户UUIDNote: 账户名称和账户UUID不能同时为空

    • expiredDate
      Timestamp必填

      会话过期日期

    • createDate
      Timestamp必填

      创建时间