Get app details

Basic Information

This interface is mainly used to obtain application details

请求路径

  1. GET /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}

request parameters

nameLocationtyperequiredChinese nameillustrate
app_idpathintegerYesapp id
team_idpathstringYesnone
region_namepathstringYesnone

return result

status codeStatus code meaningillustratedata model
200OKsuccessAppInfo

return data structure

响应示例

  1. {
  2. "ID": 0,
  3. "enterprise_id": "string",
  4. "service_count": 0,
  5. "running_service_count": 0,
  6. "used_momory": 0,
  7. "used_cpu": 0,
  8. "app_id": 0,
  9. "team_name": "string",
  10. "status": "running",
  11. "tenant_id": "string",
  12. "group_name": "string",
  13. "region_name": "string",
  14. "is_default ": true,
  15. "order_index": -2147483648,
  16. "note": "string",
  17. "username": "string",
  18. "governance_mode": "string",
  19. "create_time": "2019-08-24T14 :15:22Z",
  20. "update_time": "2019-08-24T14:15:22Z",
  21. "app_type": "string",
  22. "app_store_name": "string",
  23. "app_store_url": "string",
  24. "app_template_name": "string",
  25. "version": "string",
  26. "logo": "string",
  27. "k8s_app": "string"
  28. }

Model

AppInfo

  1. {
  2. "ID": 0,
  3. "enterprise_id": "string",
  4. "service_count": 0,
  5. "running_service_count": 0,
  6. "used_momory": 0,
  7. "used_cpu": 0,
  8. "app_id": 0,
  9. "team_name": "string",
  10. "status": "running",
  11. "tenant_id": "string",
  12. "group_name": "string",
  13. "region_name": "string",
  14. "is_default ": true,
  15. "order_index": -2147483648,
  16. "note": "string",
  17. "username": "string",
  18. "governance_mode": "string",
  19. "create_time": "2019-08-24T14 :15:22Z",
  20. "update_time": "2019-08-24T14:15:22Z",
  21. "app_type": "string",
  22. "app_store_name": "string",
  23. "app_store_url": "string",
  24. "app_template_name": "string",
  25. "version": "string",
  26. "logo": "string",
  27. "k8s_app": "string"
  28. }

Attributes

nametyperequiredconstraintChinese nameillustrate
IDintegerfalseread-onlyIDnone
enterprise_idstringtruenoneEnterprise idEnterprise ID (Federated Cloud ID)
service_countintegertruenoneService countnumber of components
running_service_countintegertruenoneRunning service countnumber of components running
used_momoryintegertruenoneUsed momoryallocated memory
used_cpuintegertruenoneused cpuallocated cpu
app_idintegertruenoneApp idapp id
team_namestringtruenoneTeam nameteam name
statusstringtruenoneStatusapplication status
tenant_idstringtruenoneTenant idtenant id
group_namestringtruenoneGroup namegroup name
region_namestringtruenoneRegion nameRegional center name
is_defaultbooleanfalsenoneIs defaultdefault components
order_indexintegerfalsenoneOrder indexApply sorting
notestring¦nullfalsenoneNoteRemark
usernamestring¦nullfalsenoneUsernamethe username of principal
governance_modestring¦nullfalsenoneGovernance modegovernance mode
create_timestring(date-time)truenoneCreate timecreation time
update_timestring(date-time)truenoneUpdate timeupdate time
app_typestringfalsenoneApp typeApp types
app_store_namestring¦nullfalsenoneApp store nameapp store name
app_store_urlstring¦nullfalsenoneApp store urlApp store URL
app_template_namestring¦nullfalsenoneApp template nameApp template name
versionstring¦nullfalsenoneVersionHelm app version
logostring¦nullfalsenoneLogoapplication logo
k8s_appstringfalsenoneK8s appIn-cluster application name

enumeration value

Attributesvalue
statusrunning
statuspart_running
statusclosed