获取空间组员信息
功能介绍
功能描述:用户可以使用该接口获取空间组员信息
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/leagues/{league_id}/partners
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id,最大32位,字母和数字组成 最小长度:0 最大长度:32 |
league_id |
是 |
String |
空间id,最大32位,字母和数字组成 最小长度:0 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
是 |
Integer |
每页记录数,取值0-100 最小值:0 最大值:100 缺省值:10 |
offset |
是 |
Integer |
记录数偏移量 最小值:0 最大值:2147483647 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户凭证 |
Content-Type |
是 |
String |
消息体的类型(格式) 缺省值:application/json |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
lists |
Array of TicsLeaguePartnerVo objects |
实例集合 |
total |
Long |
总记录数 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
空间合作方Id |
partner_domain_alias |
String |
空间合作方别名 |
partner_domain_name |
String |
空间合作方租户名 |
partner_status |
String |
空间合作方状态 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
获取空间组员信息
get /v1/{project_id}/leagues/{league_id}/partners?offset=0&limit=10
响应示例
状态码: 200
获取空间组员信息成功
{ "total" : 3, "lists" : [ { "id" : "8e06e2722ef54f67a8b42e9609f3cf04", "partner_domain_name" : "user1", "partner_domain_alias" : "dayu003", "partner_status" : "JOINED" }, { "id" : "2820810528fc4f1ba7eda2ae2de0a119", "partner_domain_name" : "user2", "partner_domain_alias" : "tics02", "partner_status" : "JOINED" }, { "id" : "351bbd7f60e54c9d93d1a4e0b1a099bc", "partner_domain_name" : "user2", "partner_domain_alias" : "space_creator", "partner_status" : "JOINED" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
获取空间组员信息成功 |
500 |
获取空间组员信息失败 |