返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态。

对于获取用户Token接口，如果调用后返回状态码为“200”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。获取Token后，您就可以使用Token认证调用其他API。

图1 获取用户Token响应消息头

响应消息体

响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{
  "error_code" : null,
  "error_msg" : null,
  "data" : {
    "token_id" : "x-883yc6ar2phgc6fsk7vz866ms6rw04vypi6kc7im1hc9pjimuk2omqdh8bftftnyurinc8rzem7xhdqrbwmp06k7o6uo48c97wthqn6lg7emuqamrtjs89dche0ac8k7",
    "expired_date" : "2021-12-31T09:57:11.571Z"
  }
}

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{
  "exceptionId" : "user.login.user_or_value_invalid",
  "exceptionType" : "EX_FRAME_EXCEPTION",
  "descArgs" : null,
  "reasonArgs" : null,
  "detailArgs" : null,
  "adviceArgs" : null,
  "exceptionMessage" : "用户名或密码错误。"
}

其中，exceptionType表示错误码，exceptionMessage表示错误描述信息。