从应用商店安装应用

基本信息

该接口主要用于从应用商店安装应用

请求路径

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

Body 请求体示例

  1. {
  2. "market_url": "https://hub.grapps.cn",
  3. "market_domain": "rainbond",
  4. "market_type": "rainstore",
  5. "market_access_key": "123456789012340af5dff63cb740788e",
  6. "app_model_id": "string",
  7. "app_model_version": "string"
  8. }

market_type 默认值传 rainstore

请求参数

名称位置类型必选中文名说明
app_idpathinteger应用组id
team_idpathstringnone
region_namepathstringnone
is_deployquerystring是否构建
bodybodyInstallnone

返回结果

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

返回数据结构

响应示例

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

模型

Install

  1. {
  2. "market_url": "string",
  3. "market_domain": "string",
  4. "market_type": "string",
  5. "market_access_key": "string",
  6. "app_model_id": "string",
  7. "app_model_version": "string"
  8. }

属性

名称类型必选约束中文名说明
market_urlstringtruenoneMarket url应用商店路由
market_domainstringtruenoneMarket domain应用商店domain
market_typestringtruenoneMarket type应用商店类型
market_access_keystringtruenoneMarket access key应用商店令牌
app_model_idstringtruenoneApp model id应用id
app_model_versionstringtruenoneApp model version应用版本

MarketInstall

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

属性

名称类型必选约束中文名说明
enterprise_idstringtruenoneEnterprise id企业ID(联合云ID)
team_idstringtruenoneTeam id团队id
notestringtruenoneNote备注
IDintegertruenoneId应用id
region_namestringtruenoneRegion name数据中心名
service_list[ServiceBaseInfo]truenonenone

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集群组件名称