Skip to main content

Get team list

Basic Information

This interface is mainly used to obtain the list of teams that the user belongs to.

请求路径
GET /openapi/v1/teams

request parameters

nameLocationtyperequiredChinese nameillustrate
queryquerystringnoTeam name search
pagequerystringnopage number
page_sizequerystringnoQuantity per page

return result

status codeStatus code meaningillustratedata model
200OKsuccessListTeamResp

Model

ListTeamResp

{
"total": 0,
"tenants": [
{
"tenant_id": "string",
"tenant_name": "string",
"tenant_alias": "string",
"enterprise_id": "string ",
"is_active": true,
"create_time": "string",
"creater": "string",
"role_infos": [
{
"role_name": "string",
"role_id": " string"
}
],
"service_num": 0,
"region_num": 0
}
]
}

Attributes

nametyperequiredconstraintChinese nameillustrate
totalintegerfalsenoneTotalnone
tenants[TeamInfo]truenonenone

TeamInfo

{
"tenant_id": "string",
"tenant_name": "string",
"tenant_alias": "string",
"enterprise_id": "string",
"is_active": true,
"create_time": " string",
"creater": "string",
"role_infos": [
{
"role_name": "string",
"role_id": "string"
}
],
"service_num": 0,
"region_num": 0
}

Attributes

nametyperequiredconstraintChinese nameillustrate
tenant_idstringtruenoneTenant idTeam ID
tenant_namestringtruenoneTenant nameTeam Name
tenant_aliasstringtruenoneTenant aliasteam alias
enterprise_idstringtruenoneEnterprise idEnterprise ID
is_activebooleanfalsenoneIs activeActivate now
create_timestringfalsenoneCreate timecreation time
creatorstringfalsenoneCreaterTeam owner user
role_infos[RoleInfo]falsenoneThe roles the user has in the team
service_numintegerfalsenoneService numThe number of components in the team
region_numintegerfalsenoneRegion numThe number of data centers opened by the team

RoleInfo

{
"role_name": "string",
"role_id": "string"
}

Attributes

nametyperequiredconstraintChinese nameillustrate
role_namestringtruenoneRole nameRole Name
role_idstringtruenoneRole idrole id