更新时间:2025-09-24 GMT+08:00
分享

获取token

典型场景

多集群场景使用,三方系统对接,使用访问控制器Global IP获取token的接口。

接口功能

多集群场景下,提供北向获取token功能。

接口约束

多集群场景下,使用Global IP地址。

调用方法

POST

URI

/controller/campus/api/v1/multiregion/tokens

表1 query参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

regionName

string

0~64个字符。

-

区域名称。

"Region1"

请求参数

表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

authCredit

REFERENCE

详细请参见表3

获取token入参

-

表3 AuthCreditIn对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

userName

string

1~128个字符。

-

用户名

"xxx@xxx.xxx"

password

password

5~128个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

用户密码

"******"

请求示例

HTTP的示例
POST /controller/campus/api/v1/multiregion/tokens?regionName=Region1 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json;charset=UTF-8
Accept: application/json
{
    "userName": "xxx@xxx.xxx",
    "password": "******"
}

响应参数

返回状态码为200:认证成功

表4 AuthTokenOut对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

data

REFERENCE

详细请参见表5

-

-

errcode

string

0~128个字符。

-

错误码

"0"

errmsg

string

0~128个字符。

-

错误信息

""

表5 AuthTokenOutData对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

token_id

string

0~1024个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

token标识

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

expiredDate

string

0~128个字符。

-

token过期时间,时间格式是:yyyy-MM-dd HH:mm:ss'

"2018-10-30 10:09:23"

regionName

string

1~64个字符。

-

Region名称

"region1"

regionAddress

string

1~64个字符。

-

Region ip或域名

"192.168.1.126"

返回状态码为401:认证失败

详细信息请参见实际响应消息体。

响应示例

返回状态码为200:认证成功

HTTP/1.1 200 OK
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"data" : {
		"token_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
		"expiredDate" : "2018-10-30 10:09:23",
		"regionName" : "region1",
		"regionAddress" : "192.168.1.126"
	},
	"errcode" : "0",
	"errmsg" : ""
}

返回状态码为401:认证失败

HTTP/1.1 401 Unauthorized
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

相关文档