部署 CODEARTS DEPLOY-通过模板新建应用:请求参数

时间:2024-04-10 16:24:47

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json

缺省值:application/json;charset=utf-8

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

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

最小长度:0

最大长度:20000

表2 请求Body参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

project_name

String

项目名称

最小长度:3

最大长度:128

template_id

String

部署模板id

task_name

String

应用名称

最小长度:3

最大长度:128

slave_cluster_id

String

自定义slave资源池id

configs

Array of ConfigInfoDO objects

部署参数类

表3 ConfigInfoDO

参数

是否必选

参数类型

描述

name

String

部署参数名称,用户可自定义

type

String

类型,如果填写name字段,则type必选,若type为空则默认为text

枚举值:

  • text

  • host_group

  • enum

  • encrypt

description

String

描述

value

String

部署参数值

task_id

String

部署任务id,创建应用后由系统自动生成

最小长度:32

最大长度:32

static_status

Integer

表示是否为静态参数,值为1时不支持部署时变更参数,值为0时支持,并且也会把该参数上报流水线

缺省值:1

枚举值:

  • 0

  • 1

limits

Array of ParamTypeLimits objects

当参数类型为enum枚举类型时,必须填写可选值

数组长度:0 - 30

表4 ParamTypeLimits

参数

是否必选

参数类型

描述

name

String

枚举值可选参数

最小长度:1

最大长度:128

support.huaweicloud.com/api-deployman/CreateDeployTaskByTemplate.html