DeployApplication - 部署应用

需要部署的应用 ID。

部署包依赖的 JDK 版本。支持版本如下：

• Open JDK 8
• Open JDK 7
• Dragonwell 11
• Dragonwell 8
• openjdk-8u191-jdk-alpine3.9
• openjdk-7u201-jdk-alpine3.9

当Package Type为 Image 时不支持。

部署包依赖的 Tomcat 版本。支持版本如下：

• apache-tomcat-7.0.91
• apache-tomcat-8.5.42

当Package Type为 Image 时不支持。

部署包的版本号。当Package Type为 FatJar、War 或 PythonZip 时必填。

部署包地址。当Package Type为 FatJar、War 或 PythonZip 时必填。

镜像地址。当Package Type为 Image 时必填。

镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下：

command:
      - echo
      - abc
      - >
      - file0

根据上述示例，则Command="echo", CommandArgs=["abc", ">", "file0"]。

镜像启动命令参数。上述启动命令 Command 所需参数。格式如下：

["a","b"]

在上述示例中，CommandArgs=["abc", ">", "file0"]，其中["abc", ">", "file0"]需要转成 String 类型，里面的格式为 JSON 数组。如果无此参数，则无需填写。

容器环境变量参数。支持自定义或引用配置项。如需引用配置项，请先创建 ConfigMap 实例。更多信息，请参见 CreateConfigMap 。取值说明如下：

• 自定义配置
  • name：环境变量名称。
  • value：环境变量值。优先级高于 valueFrom。
• 引用配置项（valueFrom）
  • name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入sae-sys-configmap-all-<配置项名称>，例如sae-sys-configmap-all-test1。
  • valueFrom：环境变量引用。取值为configMapRef。
  • configMapId：配置项 ID。
  • key：键。如果引用全部健值，则不设置该字段。
• 引用保密字典（valueFrom）
  • name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入sae-sys-secret-all-<保密字典名称>，例如sae-sys-secret-all-test1。
  • valueFrom：环境变量引用。取值为secretRef。
  • secretId：保密字典 ID。
  • key：键。如果引用全部健值，则不设置该字段。

容器内自定义 Host 映射。取值说明如下：

• hostName：域名或主机名。
• ip：IP 地址。

JAR 包启动应用选项。应用默认启动命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

JAR 包启动应用参数。应用默认启动命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

容器健康检查，健康检查失败的容器将被关闭并恢复。支持方式如下：

• exec：例如 {"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}
• httpGet：例如{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}
• tcpSocket：例如{"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

参数说明如下：

• exec.command：设置健康检查命令。
• httpGet.path：访问路径。
• httpGet.scheme：HTTP 或 HTTPS。
• httpGet.isContainKeyWord：true 表示包含关键字，false 表示不包含关键字，缺失该字段表示不使用高级功能。
• httpGet.keyWord：自定义的关键字，使用时不能缺失 isContainKeyWord 字段。
• tcpSocket.port：tcp 连接检测的端口 。
• initialDelaySeconds：设置健康检查延迟检测时间，默认为 10，单位为秒。
• periodSeconds：设置健康检查周期，默认为 30，单位为秒。
• timeoutSeconds：设置健康检查超时等待时间，默认为 1，单位为秒。如果设置为 0 或不设置，默认超时等待时间为 1 秒。

应用启动状态检查，多次健康检查失败的容器将被关闭并重启。不通过健康检查的容器将不会有 SLB 流量进入。支持 exec、httpGet 和 tcpSocket 方式。具体示例，请参见 Liveness 参数。

最小存活实例数。取值说明如下：

• 如果设置为 0，应用在升级过程中将会中断业务。
• 如果设置为**-1**，最小存活实例数将使用系统推荐值，即取现有实例数的 25%。如果当前为 5 个实例，5×25%=1.25，向上取整后，最小存活实例数为 2。

最小存活实例数百分比。取值说明如下：

• -1：初始化值，表示不采用百分比。
• 0~100：单位为百分比，向上取整。例如设置为 50%，如果当前为 5 个实例，则最小存活实例数为 3。

批次内部署间隔，单位为秒。

HSF 框架中应用运行环境版本，例如 Ali-Tomcat 容器。

部署策略。当最小存活实例数等于 1 时，UpdateStrategy 字段的值为""。当最小存活实例数大于 1 时，示例如下：

• 灰度 1 台+后续分 2 批+自动分批+分批间隔 1 分钟：{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}
• 灰度 1 台+后续分 2 批+手动分批：{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}
• 分 2 批+自动分批+分批间隔 0 分钟：{"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

参数说明如下：

• type：发布策略类型，可选灰度发布 GrayBatchUpdate 或分批发布 BatchUpdate。

• batchUpdate：分批发布策略。

  • batch：发布批次。
  • releaseType：分批间处理方式，可选自动 auto 或手动 manual。
  • batchWaitTime：分批间隔时间，单位为分钟。

• grayUpdate：灰度实例数量，当 type 为 GrayBatchUpdate 时必填。

日志采集到 SLS 的配置。

• 使用 SAE 自动创建的 SLS 资源：[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]。
• 使用自定义的 SLS 资源：[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]。

参数说明如下：

• projectName：配置 SLS 上的 Project 名称。
• logDir：日志路径。
• logType：日志类型。stdout 表示容器标准输出日志，仅可设置 1 条；如果不设置，则表示收集文件日志。
• logstoreName：配置 SLS 上的 Logstore 名称。
• logtailName：配置 SLS 上的 Logtail 名称，如果不指定，则表示新建 Logtail。

多次部署时如果 SLS 采集配置没有变更，则不需要设置该参数（即请求中无需包含 SlsConfigs 字段）；如果不再需要使用 SLS 采集功能，您需要在请求中将该字段的值设置为空字符串（即请求中 SlsConfigs 字段的值为""）。

时区，默认为Asia/Shanghai。

不推荐配置该字段，推荐配置 NasConfigs。NAS 文件系统的 ID。部署时如果配置没有变更，则不需要设置该参数（即请求中无需包含 NasId 字段）；如果需要清除 NAS 配置，您需要在请求中将该字段的值设置为空字符串（即请求中 NasId 字段的值为""）。

不推荐配置该字段，推荐配置 NasConfigs。NAS 在应用 VPC 内的挂载点。部署时如果配置没有变更，则不需要设置该参数（即请求中无需包含 MountHost 字段）；如果需要清除 NAS 配置，您需要在请求中将该字段的值设置为空字符串（即请求中 MountHost 字段的值为""）。

不推荐配置该字段，推荐配置 NasConfigs。NAS 挂载描述。部署时如果配置没有变更，则不需要设置该参数（即请求中无需包含 MountDesc 字段）；如果需要清除 NAS 配置，您需要在请求中将该字段的值设置为空字符串（即请求中 MountDesc 字段的值为""）。

容器启动后执行脚本。在容器被创建后立刻触发执行一段脚本，格式如：{"exec":{"command":\["sh","-c","echo hello"\]}}

容器停止前执行脚本。在容器被删除前触发执行一段脚本，格式如：{"exec":{"command":\["sh","-c","echo hello"\]}}

发布单描述信息。

设置 WAR 包部署应用的启动命令，操作步骤与镜像部署的启动命令配置操作相同。更多信息，请参见设置启动命令。

是否自动启用应用弹性伸缩策略。取值说明如下：

• true：开启。
• false：关闭。

ConfigMap 挂载描述。使用在命名空间配置项页面创建的配置项来向容器中注入配置信息。参数说明如下：

• configMapId：ConfigMap 实例 ID。可通过调用 ListNamespacedConfigMaps 接口获取。
• key：键值。

• mountPath：挂载路径。

优雅下线超时时间，默认为 30，单位为秒。取值范围为 1~300。

是否接入 AHAS。取值说明如下：

• true：接入 AHAS。
• false：不接入 AHAS。

PHP 应用监控挂载路径，需要您保证 PHP 服务器一定会加载这个路径的配置文件。您无需关注配置内容，SAE 会自动渲染正确的配置文件。

PHP 应用启动配置挂载路径，需要您保证 PHP 服务器会使用这个配置文件启动。

PHP 配置文件内容。

Tomcat 文件配置，设置为""或"{}"表示删除配置。取值说明如下：

• port：端口范围为 1024~65535，小于 1024 的端口需要 Root 权限才能操作。因为容器配置的是 Admin 权限，所以请填写大于 1024 的端口。如果不配置，则默认为 8080。
• contextPath：访问路径，默认为根目录"/"。
• maxThreads：配置连接池的连接数大小，默认大小为 400。
• uriEncoding：Tomcat 的编码格式，包括UTF-8、ISO-8859-1、GBK 和 GB2312。如果不设置，则默认为ISO-8859-1。
• useBodyEncodingForUri：是否使用BodyEncoding for URL，默认为 true。

OSS 挂载描述信息。参数说明如下：

• bucketName：Bucket 名称。
• bucketPath：您在 OSS 创建的目录或 OSS 对象，如果 OSS 挂载目录不存在，会触发异常。
• mountPath：您在 SAE 的容器路径。如果路径已存在，为覆盖关系；如果路径不存在，会新建。
• readOnly：容器路径是否对挂载目录资源有可读权限，取值说明如下：
  • true：只读权限。
  • false：读写权限。

OSS 读写的 AccessKey ID。

OSS 读写的 AccessKey Secret。

是否启用流量灰度规则。该规则仅适用于 Spring Cloud 和 Dubbo 框架的应用。取值说明如下：

• true：启用灰度规则。
• false：禁用灰度规则。

PHP 部署包依赖的 PHP 版本。镜像不支持。

ACR 企业版实例 ID。当 ImageUrl 为容器镜像服务企业版时必填。

跨账号拉取镜像时所需的 RAM 角色的 ARN。更多信息，请参见通过 RAM 角色实现跨云账号授权。

对应保密字典 ID。

是否绑定 EIP。取值说明如下：

• true：绑定。
• false：不绑定。

日志采集到 Kafka 的配置汇总信息。取值说明如下：

• kafkaEndpoint：Kafka API 的服务接入地址。
• kafkaInstanceId：Kafka 实例 ID。
• kafkaConfigs：单条或多条日志的配置汇总信息。示例值与参数说明，请参见本文的请求参数** kafkaConfigs**。

开启 K8s Service 服务注册发现。取值说明如下：

• portProtocols：端口与协议。端口取值范围为[1,65535]，协议支持 TCP 和 UDP。
• portAndProtocol：端口与协议。端口取值范围为[1,65535]，协议支持 TCP 和 UDP。优先推荐 portProtocols，如果设置了 portProtocols，仅 portProtocols 生效。
• enable：开启 K8s Service 服务注册发现。

选择 Nacos 注册中心，取值说明如下：

• 0：SAE 内置 Nacos。
• 1：用户自建 Nacos。
• 2：MSE 商业版 Nacos。

注册中心配置，仅在注册中心类型为 MSE Nacos 企业版时生效

挂载 NAS 的配置。取值说明如下：

• mountPath：容器挂载路径。
• readOnly：取值为 false 时，表示拥有读写权限。
• nasId：NAS ID。
• mountDomain：容器挂载点地址。更多信息，请参见 DescribeMountTargets 。
• nasPath：NAS 相对文件目录。

Python 环境。支持PYTHON 3.9.15。

自定义安装模块依赖。默认安装根目录下 requirements.txt 定义的依赖项。如果未配置或自定义软件包，可以指定安装的依赖。

.NET 框架的版本号：

• .NET 3.1
• .NET 5.0
• .NET 6.0
• .NET 7.0
• .NET 8.0

该参数仅对停止状态的应用生效。如果运行中的应用调用 DeployApplication 接口，会立即重新部署。

• true：默认值。表示立即部署，生效新的部署配置，并立即拉起实例。
• false：表示仅生效新的部署配置，不会拉起应用实例。

应用包类型。取值说明如下：

• 当您选择用 Java 部署时，支持 FatJar、War 和 Image。
• 当您选择用 PHP 部署时，支持类型如下：
  • PhpZip
  • IMAGE_PHP_5_4
  • IMAGE_PHP_5_4_ALPINE
  • IMAGE_PHP_5_5
  • IMAGE_PHP_5_5_ALPINE
  • IMAGE_PHP_5_6
  • IMAGE_PHP_5_6_ALPINE
  • IMAGE_PHP_7_0
  • IMAGE_PHP_7_0_ALPINE
  • IMAGE_PHP_7_1
  • IMAGE_PHP_7_1_ALPINE
  • IMAGE_PHP_7_2
  • IMAGE_PHP_7_2_ALPINE
  • IMAGE_PHP_7_3
  • IMAGE_PHP_7_3_ALPINE
• 当您选择用 Python 部署时，支持 PythonZip 和 Image。

每个实例所需的 CPU，单位为毫核，不能为 0。目前仅支持以下固定规格：

• 500
• 1000
• 2000
• 4000
• 8000
• 12000
• 16000
• 32000

每个实例所需的内存，单位为 MB，不能为 0。与 CPU 为一一对应关系，目前仅支持以下固定规格：

• 1024：对应 CPU 为 500 毫核和 1000 毫核。
• 2048：对应 CPU 为 500、1000 毫核和 2000 毫核。
• 4096：对应 CPU 为 1000、2000 毫核和 4000 毫核。
• 8192：对应 CPU 为 2000、4000 毫核和 8000 毫核。
• 12288：对应 CPU 为 12000 毫核。
• 16384：对应 CPU 为 4000、8000 毫核和 16000 毫核。
• 24576：对应 CPU 为 12000 毫核。
• 32768：对应 CPU 为 16000 毫核。
• 65536：对应 CPU 为 8000、16000 和 32000 毫核。
• 131072：对应 CPU 为 32000 毫核。

实例数。

安全组 ID。

应用实例弹性网卡所在的虚拟交换机。该交换机必须位于上述 VPC 内。

应用配置的灰度标签

是否启用新的 ARMS 功能：

• true：启用
• false：不启用

是否启用 CPU Burst 功能：

• true：启用
• false：不启用

设置身份认证服务 RAM 角色。

容器配置信息。

Secret 挂载描述。使用在命名空间保密字典页面创建的保密字典来向容器中注入保密信息。参数说明如下：

• secretId：secret 实例 ID。可通过 ListSecrets 接口获取。
• key：键值。

• mountPath：挂载路径。

是否启用 Sidecar 资源隔离：

• true：进行隔离
• false：不进行隔离