更新时间:2025-12-25 GMT+08:00

部署应用

功能介绍

根据部署任务id部署应用。

调用方法

请参见如何调用API

URI

POST /v2/tasks/{task_id}/start

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

部署任务ID。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

消息体的类型(格式)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

params

Array of DynamicConfigInfo objects

参数解释

部署应用时传递的参数。

约束限制

不涉及。

record_id

String

参数解释

应用的部署id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

trigger_source

String

参数解释

是否限制触发来源。

约束限制

不涉及。

取值范围

  • 0: 不限制任何部署请求来源。

  • 1: 只允许通过流水线触发部署。

默认取值

不涉及。

表4 DynamicConfigInfo

参数

是否必选

参数类型

描述

key

String

参数解释

部署应用时传递的参数名称。

约束限制

不涉及。

取值范围

只能由英文字母、数字、-、_、.组成,且长度为[1-128]个字符。

默认取值

不涉及。

value

String

参数解释

部署应用时传递的参数值。

约束限制

不涉及。

取值范围

长度最长为8192个字符,不支持“{{”、“{%”、“{#”字符。

默认取值

不涉及。

type

String

参数解释

部署参数类型。

约束限制

如果填写运行时设置参数,则类型必选。

取值范围

  • text: 字符串类型。

  • host_group: 环境类型。

  • encrypt: 私密类型。

  • enum: 枚举类型。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释

部署记录id。

取值范围

由英文字母、数字组成,且长度为32个字符。

task_id

String

参数解释

部署任务id。

取值范围

由英文字母、数字组成,且长度为32个字符。

job_name

String

参数解释

执行任务名称。

取值范围

由英文字母、数字、_组成,且长度为50个字符。

app_component_list

Array of AppComponentDao objects

参数解释

应用和AOM应用组件对应关系。

表6 AppComponentDao

参数

参数类型

描述

task_id

String

参数解释

部署任务ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_id

String

参数解释

AOM应用ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_name

String

参数解释

AOM应用名称。

取值范围

由英文字母、数字组成。

comp_id

String

参数解释

AOM应用组件ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

comp_name

String

参数解释

AOM应用组件名称。

取值范围

长度为[0,128]个字符。

domain_id

String

参数解释

租户ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

region

String

参数解释

局点信息。

取值范围

长度为[1,256]个字符。

state

String

参数解释

AOM应用组件是否生效。

取值范围

  • 0: 初始化

  • 1: 执行成功,已生效

请求示例

根据部署任务id部署应用。

https://{endpoint}/v2/tasks/d2dc947ec2424d8789bb3984bb3adf45/start

{
  "params" : [ {
    "key" : "string",
    "value" : "test",
    "type" : "text"
  }, {
    "key" : "env",
    "value" : "e3144513a4094398857c992606ccba12",
    "type" : "host_group"
  }, {
    "key" : "enum",
    "value" : "value1",
    "type" : "enum"
  } ],
  "trigger_source" : 0
}

响应示例

状态码:200

OK 请求响应成功

{
  "id" : "0ee9c8e6a7dc44109541e53c6dccf47c",
  "task_id" : "d2dc947ec2424d8789bb3984bb3adf45",
  "job_name" : "job_0ee9c8e6a7dc44109541e53c6dccf47c_1620810492008",
  "app_component_list" : [ ]
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码