Query the list of components under the application

Basic Information

This interface is mainly used to query the list of components under the application

请求路径

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

request parameters

nameLocationtyperequiredChinese nameillustrate
app_idpathintegerYesapp id
team_idpathstringYesnone
region_namepathstringYesnone

return result

status codeStatus code meaningillustratedata model
200OKsuccessInline

return data structure

nametyperequiredconstraintChinese nameillustrate
anonymous[ServiceBaseInfo]falsenonenone
» statusstringfalsenoneStatuscomponent status
» access_infos[string]falsenonecomponent access address
» service_idstringtruenoneService idcomponent id
» tenant_idstringtruenoneTenant idtenant id
» service_keystringtruenoneService keycomponent key
» service_aliasstringtruenoneService aliascomponent alias
» service_cnamestringfalsenoneService cnamecomponent name
» service_regionstringtruenoneService regionThe area to which the component belongs
» descstring¦nullfalsenoneDescdescribe
» categorystringtruenoneCategoryComponent classification：application, cache, store
» versionstringtruenoneVersionVersion
» update_versionintegerfalsenoneUpdate versionInternal Releases
» imagestringtruenoneImagemirror
» cmdstring¦nullfalsenoneCmdstartup parameters
» min_nodeintegerfalsenoneMin nodenumber of instances
» min_cpuintegerfalsenoneMin cpuCPU allocation 1000=1core
» container_gpuintegerfalsenoneContainer GPUsAmount of GPU memory
» min_memoryintegerfalsenoneMin memoryMemory size unit (M)
» extend_methodstringfalsenoneExtend methodComponent deployment type, stateless or state
» code_fromstring¦nullfalsenoneCode fromCode source: gitlab, github
» git_urlstring¦nullfalsenoneGit urlcode code repository
» git_project_idintegerfalsenoneGit project idProject id in gitlab
» code_versionstring¦nullfalsenoneCode versioncode version
» service_typestring¦nullfalsenoneService typeComponent type: web, mysql, redis, mongodb, phpadmin
» creatorintegerfalsenoneCreatercomponent creator
» languagestring¦nullfalsenoneLanguagecode language
» total_memoryintegerfalsenoneTotal memoryMemory usage M
» is_servicebooleanfalsenoneIs serviceWhether the inner component
» service_originstringfalsenoneService originComponent creation type cloud cloud city component, assistant cloud help component
» tenant_service_group_idintegerfalsenoneTenant service group idThe component group id to which the component belongs. For components installed from the application template, this field needs to be assigned a value
» open_webhooksbooleanfalsenoneOpen webhooksWhether to enable the automatic trigger deployment function (compatible with older version components)
» service_sourcestring¦nullfalsenoneService sourceComponent sources (source_code, market, docker_run, docker_compose)
» create_statusstring¦nullfalsenoneCreate statusComponent creation state creating
» check_uuidstring¦nullfalsenoneCheck uuidComponent detection ID
» check_event_idstring¦nullfalsenoneCheck event idComponent detection event ID
» docker_cmdstring¦nullfalsenoneDocker-cmdImage creation command
» server_typestringfalsenoneServer typeSource repository type
» is_upgratebooleanfalsenoneIs upgradeIs it possible to update
» build_upgradebooleanfalsenoneBuild upgradeWhether to upgrade components after building
» oauth_service_idinteger¦nullfalsenoneOauth service idThe OAuth service id used to pull the source code
» k8s_component_namestringtruenoneK8s component nameCluster component name

响应示例

  1. [
  2.   {
  3.     "status": "",
  4.     "access_infos": [
  5.       "string"
  6.     ],
  7.     "service_id": "string",
  8.     "tenant_id": "string",
  9.     "service_key": "string" ,
  10.     "service_alias": "string",
  11.     "service_cname": "string",
  12.     "service_region": "string",
  13.     "desc": "string",
  14.     "category": "string",
  15.     "version" : "string",
  16.     "update_version": 3,
  17.     "image": "string",
  18.     "cmd": "string",
  19.     "min_node": 3,
  20.     "min_cpu": 3,
  21.     "container_gpu": 3 ,
  22.     "min_memory": 3,
  23.     "extend_method": "string",
  24.     "code_from": "string",
  25.     "git_url": "string",
  26.     "git_project_id": 3,
  27.     "code_version": "string" ,
  28.     "service_type": "string",
  29.     "creater": 3,
  30.     "language": "string",
  31.     "total_memory": 3,
  32.     "is_service": true,
  33.     "service_origin": "string",
  34.     "tenant_service_group_id": 3,
  35.     "open_webhooks": true,
  36.     "service_source": "string",
  37.     "create_status": "string",
  38.     "check_uuid": "string",
  39.     "check_event_id": "string",
  40.     "docker_cmd": "string",
  41.     "server_type": "string",
  42.     "is_upgrate": true,
  43.     "build_upgrade": true,
  44.     "oauth_service_id": 3,
  45.     "k8s_component_name": "string"
  46.   }
  47. ]

Model

ServiceBaseInfo

  1. {
  2.   "status": "",
  3.   "access_infos": [],
  4.   "service_id": "string",
  5.   "tenant_id": "string",
  6.   "service_key": "string",
  7.   "service_alias": " string",
  8.   "service_cname": "string",
  9.   "service_region": "string",
  10.   "desc": "string",
  11.   "category": "string",
  12.   "version": "string",
  13.   " update_version": -2147483648,
  14.   "image": "string",
  15.   "cmd": "string",
  16.   "min_node": -2147483648,
  17.   "min_cpu": -2147483648,
  18.   "container_gpu": -2147483648,
  19.   " min_memory": -2147483648,
  20.   "extend_method": "string",
  21.   "code_from": "string",
  22.   "git_url": "string",
  23.   "git_project_id": -2147483648,
  24.   "code_version": "string",
  25.   "service_type": "string",
  26.   "creater": -2147483648,
  27.   "language": "string",
  28.   "total_memory": -2147483648,
  29.   "is_service": true,
  30.   "service_origin": "string",
  31.   "tenant_service_group_id": -2147483648,
  32.   "open_webhooks": true,
  33.   "service_source": "string",
  34.   "create_status": "string",
  35.   "check_uuid": "string",
  36.   "check_event_id": "string" ,
  37.   "docker_cmd": "string",
  38.   "ser ver_type": "strin",
  39.   "is_upgrate": true,
  40.   "build_upgrade": true,
  41.   "oauth_service_id": -2147483648,
  42.   "k8s_component_name": "string"
  43. }

Attributes

nametyperequiredconstraintChinese nameillustrate
statusstringfalsenoneStatuscomponent status
access_infos[string]falsenonecomponent access address
service_idstringtruenoneService idcomponent id
tenant_idstringtruenoneTenant idtenant id
service_keystringtruenoneService keycomponent key
service_aliasstringtruenoneService aliascomponent alias
service_cnamestringfalsenoneService cnamecomponent name
service_regionstringtruenoneService regionThe area to which the component belongs
descstring¦nullfalsenoneDescdescribe
categorystringtruenoneCategoryComponent classification：application, cache, store
versionstringtruenoneVersionVersion
update_versionintegerfalsenoneUpdate versionInternal Releases
imagestringtruenoneImagemirror
cmdstring¦nullfalsenoneCmdstartup parameters
min_nodeintegerfalsenoneMin nodenumber of instances
min_cpuintegerfalsenoneMin cpuCPU allocation 1000=1core
container_gpuintegerfalsenoneContainer GPUsAmount of GPU memory
min_memoryintegerfalsenoneMin memoryMemory size unit (M)
extend_methodstringfalsenoneExtend methodComponent deployment type, stateless or state
code_fromstring¦nullfalsenoneCode fromCode source: gitlab, github
git_urlstring¦nullfalsenoneGit urlcode code repository
git_project_idintegerfalsenoneGit project idProject id in gitlab
code_versionstring¦nullfalsenoneCode versioncode version
service_typestring¦nullfalsenoneService typeComponent type: web, mysql, redis, mongodb, phpadmin
creatorintegerfalsenoneCreatercomponent creator
languagestring¦nullfalsenoneLanguagecode language
total_memoryintegerfalsenoneTotal memoryMemory usage M
is_servicebooleanfalsenoneIs serviceWhether the inner component
service_originstringfalsenoneService originComponent creation type cloud cloud city component, assistant cloud help component
tenant_service_group_idintegerfalsenoneTenant service group idThe component group id to which the component belongs. For components installed from the application template, this field needs to be assigned a value
open_webhooksbooleanfalsenoneOpen webhooksWhether to enable the automatic trigger deployment function (compatible with older version components)
service_sourcestring¦nullfalsenoneService sourceComponent sources (source_code, market, docker_run, docker_compose)
create_statusstring¦nullfalsenoneCreate statusComponent creation state creating
check_uuidstring¦nullfalsenoneCheck uuidComponent detection ID
check_event_idstring¦nullfalsenoneCheck event idComponent detection event ID
docker_cmdstring¦nullfalsenoneDocker-cmdImage creation command
server_typestringfalsenoneServer typeSource repository type
is_upgratebooleanfalsenoneIs upgradeIs it possible to update
build_upgradebooleanfalsenoneBuild upgradeWhether to upgrade components after building
oauth_service_idinteger¦nullfalsenoneOauth service idThe OAuth service id used to pull the source code
k8s_component_namestringtruenoneK8s component nameCluster component name