查询应用下组件列表

基本信息

该接口主要用于查询应用下组件列表

请求路径

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

请求参数

名称位置类型必选中文名说明
app_idpathinteger是应用id
team_idpathstring是none
region_namepathstring是none

返回结果

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

名称类型必选约束中文名说明
anonymous[ServiceBaseInfo]falsenonenone
» statusstringfalsenoneStatus组件状态
» access_infos[string]falsenone组件访问地址
» service_idstringtruenoneService id组件id
» tenant_idstringtruenoneTenant id租户id
» service_keystringtruenoneService key组件key
» service_aliasstringtruenoneService alias组件别名
» service_cnamestringfalsenoneService cname组件名
» service_regionstringtruenoneService region组件所属区
» descstring¦nullfalsenoneDesc描述
» categorystringtruenoneCategory组件分类：application,cache,store
» versionstringtruenoneVersion版本
» update_versionintegerfalsenoneUpdate version内部发布次数
» imagestringtruenoneImage镜像
» cmdstring¦nullfalsenoneCmd启动参数
» min_nodeintegerfalsenoneMin node实例数量
» min_cpuintegerfalsenoneMin cpucpu分配额 1000=1core
» container_gpuintegerfalsenoneContainer gpugpu显存数量
» min_memoryintegerfalsenoneMin memory内存大小单位（M）
» extend_methodstringfalsenoneExtend method组件部署类型,stateless or state
» code_fromstring¦nullfalsenoneCode from代码来源:gitlab,github
» git_urlstring¦nullfalsenoneGit urlcode代码仓库
» git_project_idintegerfalsenoneGit project idgitlab 中项目id
» code_versionstring¦nullfalsenoneCode version代码版本
» service_typestring¦nullfalsenoneService type组件类型:web,mysql,redis,mongodb,phpadmin
» createrintegerfalsenoneCreater组件创建者
» languagestring¦nullfalsenoneLanguage代码语言
» total_memoryintegerfalsenoneTotal memory内存使用M
» is_servicebooleanfalsenoneIs service是否inner组件
» service_originstringfalsenoneService origin组件创建类型cloud云市组件,assistant云帮组件
» tenant_service_group_idintegerfalsenoneTenant service group id组件归属的组件组id，从应用模版安装的组件该字段需要赋值
» open_webhooksbooleanfalsenoneOpen webhooks是否开启自动触发部署功能（兼容老版本组件）
» service_sourcestring¦nullfalsenoneService source组件来源(source_code, market, docker_run, docker_compose)
» create_statusstring¦nullfalsenoneCreate status组件创建状态 creating
» check_uuidstring¦nullfalsenoneCheck uuid组件检测ID
» check_event_idstring¦nullfalsenoneCheck event id组件检测事件ID
» docker_cmdstring¦nullfalsenoneDocker cmd镜像创建命令
» server_typestringfalsenoneServer type源码仓库类型
» is_upgratebooleanfalsenoneIs upgrate是否可以更新
» build_upgradebooleanfalsenoneBuild upgrade组件构建后是否升级
» oauth_service_idinteger¦nullfalsenoneOauth service id拉取源码所用的OAuth服务id
» k8s_component_namestringtruenoneK8s 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. ]

模型

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.   "server_type": "strin",
  39.   "is_upgrate": true,
  40.   "build_upgrade": true,
  41.   "oauth_service_id": -2147483648,
  42.   "k8s_component_name": "string"
  43. }

属性

名称类型必选约束中文名说明
statusstringfalsenoneStatus组件状态
access_infos[string]falsenone组件访问地址
service_idstringtruenoneService id组件id
tenant_idstringtruenoneTenant id租户id
service_keystringtruenoneService key组件key
service_aliasstringtruenoneService alias组件别名
service_cnamestringfalsenoneService cname组件名
service_regionstringtruenoneService region组件所属区
descstring¦nullfalsenoneDesc描述
categorystringtruenoneCategory组件分类：application,cache,store
versionstringtruenoneVersion版本
update_versionintegerfalsenoneUpdate version内部发布次数
imagestringtruenoneImage镜像
cmdstring¦nullfalsenoneCmd启动参数
min_nodeintegerfalsenoneMin node实例数量
min_cpuintegerfalsenoneMin cpucpu分配额 1000=1core
container_gpuintegerfalsenoneContainer gpugpu显存数量
min_memoryintegerfalsenoneMin memory内存大小单位（M）
extend_methodstringfalsenoneExtend method组件部署类型,stateless or state
code_fromstring¦nullfalsenoneCode from代码来源:gitlab,github
git_urlstring¦nullfalsenoneGit urlcode代码仓库
git_project_idintegerfalsenoneGit project idgitlab 中项目id
code_versionstring¦nullfalsenoneCode version代码版本
service_typestring¦nullfalsenoneService type组件类型:web,mysql,redis,mongodb,phpadmin
createrintegerfalsenoneCreater组件创建者
languagestring¦nullfalsenoneLanguage代码语言
total_memoryintegerfalsenoneTotal memory内存使用M
is_servicebooleanfalsenoneIs service是否inner组件
service_originstringfalsenoneService origin组件创建类型cloud云市组件,assistant云帮组件
tenant_service_group_idintegerfalsenoneTenant service group id组件归属的组件组id，从应用模版安装的组件该字段需要赋值
open_webhooksbooleanfalsenoneOpen webhooks是否开启自动触发部署功能（兼容老版本组件）
service_sourcestring¦nullfalsenoneService source组件来源(source_code, market, docker_run, docker_compose)
create_statusstring¦nullfalsenoneCreate status组件创建状态 creating
check_uuidstring¦nullfalsenoneCheck uuid组件检测ID
check_event_idstring¦nullfalsenoneCheck event id组件检测事件ID
docker_cmdstring¦nullfalsenoneDocker cmd镜像创建命令
server_typestringfalsenoneServer type源码仓库类型
is_upgratebooleanfalsenoneIs upgrate是否可以更新
build_upgradebooleanfalsenoneBuild upgrade组件构建后是否升级
oauth_service_idinteger¦nullfalsenoneOauth service id拉取源码所用的OAuth服务id
k8s_component_namestringtruenoneK8s component name集群组件名称