Get team list

Basic Information

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

请求路径

  1. 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

  1. {
  2. "total": 0,
  3. "tenants": [
  4. {
  5. "tenant_id": "string",
  6. "tenant_name": "string",
  7. "tenant_alias": "string",
  8. "enterprise_id": "string ",
  9. "is_active": true,
  10. "create_time": "string",
  11. "creater": "string",
  12. "role_infos": [
  13. {
  14. "role_name": "string",
  15. "role_id": " string"
  16. }
  17. ],
  18. "service_num": 0,
  19. "region_num": 0
  20. }
  21. ]
  22. }

Attributes

nametyperequiredconstraintChinese nameillustrate
totalintegerfalsenoneTotalnone
tenants[TeamInfo]truenonenone

TeamInfo

  1. {
  2. "tenant_id": "string",
  3. "tenant_name": "string",
  4. "tenant_alias": "string",
  5. "enterprise_id": "string",
  6. "is_active": true,
  7. "create_time": " string",
  8. "creater": "string",
  9. "role_infos": [
  10. {
  11. "role_name": "string",
  12. "role_id": "string"
  13. }
  14. ],
  15. "service_num": 0,
  16. "region_num": 0
  17. }

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

  1. {
  2. "role_name": "string",
  3. "role_id": "string"
  4. }

Attributes

nametyperequiredconstraintChinese nameillustrate
role_namestringtruenoneRole nameRole Name
role_idstringtruenoneRole idrole id