Skip to main content

Get app details

Basic Information

This interface is mainly used to obtain application details

请求路径
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

响应示例
{
"ID": 0,
"enterprise_id": "string",
"service_count": 0,
"running_service_count": 0,
"used_momory": 0,
"used_cpu": 0,
"app_id": 0,
"team_name": "string",
"status": "running",
"tenant_id": "string",
"group_name": "string",
"region_name": "string",
"is_default ": true,
"order_index": -2147483648,
"note": "string",
"username": "string",
"governance_mode": "string",
"create_time": "2019-08-24T14 :15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"app_type": "string",
"app_store_name": "string",
"app_store_url": "string",
"app_template_name": "string",
"version": "string",
"logo": "string",
"k8s_app": "string"
}

Model

AppInfo

{
"ID": 0,
"enterprise_id": "string",
"service_count": 0,
"running_service_count": 0,
"used_momory": 0,
"used_cpu": 0,
"app_id": 0,
"team_name": "string",
"status": "running",
"tenant_id": "string",
"group_name": "string",
"region_name": "string",
"is_default ": true,
"order_index": -2147483648,
"note": "string",
"username": "string",
"governance_mode": "string",
"create_time": "2019-08-24T14 :15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"app_type": "string",
"app_store_name": "string",
"app_store_url": "string",
"app_template_name": "string",
"version": "string",
"logo": "string",
"k8s_app": "string"
}

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