Serverless App Engine：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 服務註冊發現。

設定基於 K8s Service 服務註冊發現和全鏈路灰度功能：

• enable：是否開啟基於 K8s Service 設定全鏈路灰度功能

  • true：開啟

  • false：關閉

• namespaceId：命名空間 ID。

• portAndProtocol：監聽連接埠及通訊協定，格式：{"連接埠:通訊協定類型":"容器連接埠"}

• portProtocols：定義服務的連接埠及通訊協定

  • port：連接埠

  • protocol：通訊協定

  • targetPort：容器連接埠

• pvtzDiscoveryName：服務發現名稱

• serviceId：服務 ID

• serviceName：服務名稱

選擇 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：不進行隔離

自訂映像類型，如果非自訂映像，需要設定為空字串：

• internet：公網映像

• intranet：私網映像

設定微服務治理功能。

• 是否開啟微服務治理（enable）：

  • ture：開啟

  • false：不開啟

• 設定無損上下線（mseLosslessRule）：

  • delayTime：延遲事件

  • enable：是否啟用無損上線功能，ture 為開啟，false 為不開啟。

  • notice：是否啟用通知功能，ture 為啟用，false 為啟用。

  • warmupTime：小流量預熱時長，單位為秒。

應用程式版本：

• lite：輕量版

• std：標準版

• pro：專業版

啟用應用程式啟動偵測。

• 檢查成功：表示應用程式啟動成功，如果您設定了 Liveness 檢查和 Readiness 檢查，應用程式啟動成功後會執行 Liveness 檢查和 Readiness 檢查。

• 檢查失敗：表示應用程式啟動失敗，會上報異常並自動重新啟動。

是否開啟 Prometheus 自訂指標採集。

Nginx 版本

• nginx 1.20

• nginx 1.22

• nginx 1.24

• nginx 1.26

• nginx 1.28

共用臨時儲存設定。

ALB 閘道就緒門控（ReadinessGate）設定。

最大峰值執行個體數。取值說明如下：

如果最小存活執行個體數為 100%，則最大峰值不能設定為 0。 如果設定為 -1，最大峰值執行個體數將使用最大峰值比例系統推薦值 30%，取現有執行個體數的 30%。如果目前為 10 個執行個體，則為 10×30%=3。

最大峰值執行個體數比例。取值說明如下：

如果最小存活執行個體數為 100%，則最大峰值不能設定為 0。 如果設定為 -1，將使用系統推薦值 30%，取現有執行個體數的 30%。如果目前為 10 個執行個體，則為 10×30%=3。

AliyunAgent 版本。

是否複用命名空間 Agent 版本設定。

sls log tags