All Products
Search
Document Center

Serverless App Engine:DeployApplication

Last Updated:Oct 21, 2026

Deploys an application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DeployApplication

update

*All Resource

*

None None

Request syntax

POST /pop/v1/sam/app/deployApplication HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The ID of the application to be deployed.

7171a6ca-d1cd-4928-8642-7d5cfe69****

Jdk

string

No

The JDK version required by the deployment package. Valid values:

  • Open JDK 8

  • Open JDK 7

  • Dragonwell 11

  • Dragonwell 8

  • openjdk-8u191-jdk-alpine3.9

  • openjdk-7u201-jdk-alpine3.9

This parameter is not supported when Package Type is set to Image.

Open JDK 8

WebContainer

string

No

The Tomcat version required by the deployment package. Valid values:

  • apache-tomcat-7.0.91

  • apache-tomcat-8.5.42

This parameter is not supported when Package Type is set to Image.

apache-tomcat-7.0.91

PackageVersion

string

No

The version number of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip.

1.0.1

PackageUrl

string

No

The URL of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip.

http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar

ImageUrl

string

No

The URL of the image. This parameter is required when Package Type is set to Image.

registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1

Command

string

No

The startup command of the image. The command must be an executable object that exists in the container. Example:

command:
      - echo
      - abc
      - >
      - file0

Based on the preceding example, Command="echo" and CommandArgs=["abc", ">", "file0"].

echo

CommandArgs

string

No

The arguments for the image startup command. These are the arguments required by the Command startup command. Format:

["a","b"]

In the preceding example, CommandArgs=["abc", ">", "file0"]. The ["abc", ">", "file0"] part must be converted to a string in JSON array format. If this parameter is not required, leave it empty.

["a","b"]

Envs

string

No

The environment variables for the container. You can specify custom environment variables or reference ConfigMaps. To reference a ConfigMap, you must create a ConfigMap instance first. For more information, see CreateConfigMap. Valid values:

  • Custom environment variables
    • name: the name of the environment variable.

    • value: the value of the environment variable. This parameter has a higher priority than valueFrom.

  • Reference a ConfigMap (valueFrom)
    • name: the name of the environment variable. You can reference a single key or all keys. To reference all keys, enter sae-sys-configmap-all-<ConfigMap name>, such as sae-sys-configmap-all-test1.

    • valueFrom: the reference of the environment variable. Set the value to configMapRef.

    • configMapId: the ID of the ConfigMap.

    • key: the key. If you reference all key-value pairs, do not set this field.

  • Reference a secret (valueFrom)
    • name: the name of the environment variable. You can reference a single key or all keys. To reference all keys, enter sae-sys-secret-all-<secret name>, such as sae-sys-secret-all-test1.

    • valueFrom: the reference of the environment variable. Set the value to secretRef.

    • secretId: the ID of the secret.

    • key: the key. If you reference all key-value pairs, do not set this field.

[ { "name": "sae-sys-configmap-all-hello", "valueFrom": { "configMapRef": { "configMapId": 100, "key": "" } } }, { "name": "hello", "valueFrom": { "configMapRef": { "configMapId": 101, "key": "php-fpm" } } }, { "name": "sae-sys-secret-all-hello", "valueFrom": { “secretRef": { “secretId": 100, "key": "" } } }, { "name": “password”, "valueFrom": { “secretRef": { “secretId": 101, "key": “password” } } }, { "name": "envtmp", "value": "newenv" } ]

CustomHostAlias

string

No

The custom host mappings in the container. Valid values:

  • hostName: the domain name or hostname.

  • ip: the IP address.

[{"hostName":"samplehost","ip":"127.0.0.1"}]

JarStartOptions

string

No

The startup options for the JAR package. Default startup command: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

custom-option

JarStartArgs

string

No

The startup arguments for the JAR package. Default startup command: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

-Xms4G -Xmx4G

Liveness

string

No

The liveness probe for the container. Containers that fail the health check are shutdown and recovered. Valid values:

  • exec: Example: {"exec":{"command":["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}.

  • httpGet: Example: {"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}.

  • tcpSocket: Example: {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}.

Note

You can select only one method for the health check.

Parameter description:

  • exec.command: Settings for the health check command.

  • httpGet.path: the access path.

  • httpGet.scheme: HTTP or HTTPS.

  • httpGet.isContainKeyWord: true indicates that the keyword is included, and false indicates that the keyword is not included. If this field is missing, the advanced feature is not used.

  • httpGet.keyWord: the custom keyword. The isContainKeyWord field is required when this field is used.

  • tcpSocket.port: the port for TCP connection detection.

  • initialDelaySeconds: Settings for the health check delay detection time. Default value: 10. Unit: seconds.

  • periodSeconds: Settings for the health check epoch. Default value: 30. Unit: seconds.

  • timeoutSeconds: Settings for the health check timeout waiting time. Default value: 1. Unit: seconds. If this parameter is set to 0 or not set, the default timeout waiting time is 1 second.

{"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}

Readiness

string

No

The readiness probe for the application. Containers that fail multiple health checks are stopped and restarted. Traffic from the SLB instance is not routed to containers that fail the health check. The exec, httpGet, and tcpSocket methods are supported. For specific examples, see the Liveness parameter.

Note

You can select only one method for the health check.

{"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}

MinReadyInstances

integer

No

The minimum number of ready instances. Valid values:

  • If you set this parameter to 0, services are interrupted during the application upgrade.

  • If you set this parameter to -1, the system recommended value is used, which is 25% of the current number of instances. For example, if the current number of instances is 5, 5 × 25% = 1.25. After rounding up, the minimum number of ready instances is 2.

Note

Set the minimum number of ready instances to a value greater than or equal to 1 for each rolling deployment to ensure service continuity.

1

MinReadyInstanceRatio

integer

No

The percentage of the minimum number of ready instances. Valid values:

  • -1: the initial value, which indicates that the percentage is not used.

  • 0~100: the percentage, rounded up. For example, if you set this parameter to 50 and the current number of instances is 5, the minimum number of ready instances is 3.

Note

When both MinReadyInstance and MinReadyInstanceRatio are passed and the value of MinReadyInstanceRatio is not -1, the MinReadyInstanceRatio parameter prevails. For example, if MinReadyInstances is set to 5 and MinReadyInstanceRatio is set to 50, 50 is used to calculate the minimum number of ready instances.

-1

BatchWaitTime

integer

No

The interval between deployment batches. Unit: seconds.

10

EdasContainerVersion

string

No

The version of the application runtime environment in the HSF framework, such as the Ali-Tomcat container.

3.5.3

UpdateStrategy

string

No

The deployment policy. When the minimum number of ready instances is 1, the value of the UpdateStrategy field is "". When the minimum number of ready instances is greater than 1, examples are as follows:

  • grayscale 1 instance + 2 subsequent batches + automatic batching + 1-minute interval between batches: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

  • grayscale 1 instance + 2 subsequent batches + manual batching: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

  • 2 batches + automatic batching + 0-minute interval between batches: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

Parameter description:

  • type: the type of the publish policy. Valid values: GrayBatchUpdate for grayscale publish and BatchUpdate for batch publish.

  • batchUpdate: the batch publish policy.

    • batch: the number of publish batches.

    • releaseType: the processing method between batches. Valid values: auto for automatic and manual for manual.

    • batchWaitTime: the interval between batches. Unit: minutes.

  • grayUpdate: the number of grayscale instances. This parameter is required when type is set to GrayBatchUpdate.

{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

SlsConfigs

string

No

The Settings for collecting logs to Simple Log Service (SLS).

  • Use SLS resources automatically created by SAE: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

  • Use custom SLS resources: [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].

Parameter description:

  • projectName: the name of the SLS project.

  • logDir: the log path.

  • logType: the log type. stdout indicates container standard output logs. You can set only 1 standard output log. If this parameter is not set, file logs are collected.

  • logstoreName: the name of the SLS Logstore.

  • logtailName: the name of the SLS Logtail. If this parameter is not specified, a new Logtail is created.

If the SLS collection Settings remain unchanged during multiple deployments, you do not need to set this parameter. That is, you do not need to include the SlsConfigs field in the request. If you no longer need the SLS collection feature, you must set the value of this field to an empty string in the request. That is, set the SlsConfigs field to "".

Note

Projects that are automatically created with the application are deleted when the application is deleted. Therefore, when you select an existing project, you cannot select a project that is automatically created by SAE.

[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

Timezone

string

No

The time zone. Default value: Asia/Shanghai.

Asia/Shanghai

NasId

string

No

This field is not recommended. Configure NasConfigs instead. The ID of the NAS file system. If the configurations remain unchanged during deployment, you do not need to set this parameter. That is, you do not need to include the NasId field in the request. If you need to clear the NAS configurations, you must set the value of this field to an empty string in the request. That is, set the NasId field to "".

10d3b4****

MountHost

string

No

This field is not recommended. Configure NasConfigs instead. The mount target of the NAS file system in the VPC of the application. If the configurations remain unchanged during deployment, you do not need to set this parameter. That is, you do not need to include the MountHost field in the request. If you need to clear the NAS configurations, you must set the value of this field to an empty string in the request. That is, set the MountHost field to "".

10d3b4bc9****.com

MountDesc

string

No

This field is not recommended. Configure NasConfigs instead. The description of the NAS mount. If the configurations remain unchanged during deployment, you do not need to set this parameter. That is, you do not need to include the MountDesc field in the request. If you need to clear the NAS configurations, you must set the value of this field to an empty string in the request. That is, set the MountDesc field to "".

[{mountPath: "/tmp", nasPath: "/"}]

PostStart

string

No

The script to execute after the container starts. A script is triggered immediately after the container is created. Format: {"exec":{"command":["sh","-c","echo hello"]}}.

{"exec":{"command":["sh","-c","echo hello"]}}

PreStop

string

No

The script to execute before the container stops. A script is triggered before the container is deleted. Format: {"exec":{"command":["sh","-c","echo hello"]}}.

{"exec":{"command":["sh","-c","echo hello"]}}

ChangeOrderDesc

string

No

The description of the change order.

Start application

WarStartOptions

string

No

The startup command for the application deployed by using a WAR package. The procedure is the same as that for configuring the startup command for image deployment. For more information, see Configure a startup command.

CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run

AutoEnableApplicationScalingRule

boolean

No

Specifies whether the elastic scaling policy for the application is automatically enabled. Valid values:

  • true: enables the policy.

  • false: shutdown.

true

ConfigMapMountDesc

string

No

The mount description of the ConfigMap. Uses the configuration item created on the configuration item page of the namespace to inject configuration information into the container. Parameter description:

  • configMapId: the instance ID of the ConfigMap instance. You can invoke the ListNamespacedConfigMaps operation to obtain the instance ID.

  • key: the key value.

Note

You can mount all keys by passing the sae-sys-configmap-all parameter.

  • mountPath: the mount path.

[{"configMapId":16,"key":"test","mountPath":"/tmp"}]

TerminationGracePeriodSeconds

integer

No

The timeout period for graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300.

10

EnableAhas

string

No

Specifies whether to connect to AHAS. Valid values:

  • true: connects to AHAS.

  • false: does not connect to AHAS.

false

PhpArmsConfigLocation

string

No

The mount path for PHP application monitoring. You must ensure that the PHP server loads the configuration file in this path. You do not need to pay attention to the configuration content. SAE automatically renders the correct configuration file.

/usr/local/etc/php/conf.d/arms.ini

PhpConfigLocation

string

No

The mount path for the PHP application startup configuration. You must ensure that the PHP server uses this configuration file to start.

/usr/local/etc/php/php.ini

PhpConfig

string

No

The content of the PHP configuration file.

k1=v1

TomcatConfig

string

No

The Tomcat file configuration. Set the value to "" or "{}" to delete the configuration. Valid values:

  • port: the port range is 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with admin permissions, specify a port greater than 1024. If this parameter is not configured, the default value is 8080.

  • contextPath: the access path. Default value: the root directory "/".

  • maxThreads: the maximum number of connections in the connection pool. Default value: 400.

  • uriEncoding: the encoding format of Tomcat. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If this parameter is not set, the default value is ISO-8859-1.

  • useBodyEncodingForUri: specifies whether to use BodyEncoding for URL. Default value: true.

{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}

OssMountDescs

string

No

The OSS mount description. Parameter description:

  • bucketName: the name of the bucket.

  • bucketPath: the folder or object that you created in OSS. If the OSS mount folder does not exist, an exception is triggered.

  • mountPath: the container path in SAE. If the path already exists, it is an overwrite relationship. If the path does not exist, it is created.

  • readOnly: specifies whether the container path has read permissions on the mount directory resources. Valid values:
    • true: read-only permissions.

    • false: read and write permissions.

[{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}]

OssAkId

string

No

The AccessKey ID used to read and write OSS data.

xxxxxx

OssAkSecret

string

No

The AccessKey Secret used to read and write OSS data.

xxxxxx

EnableGreyTagRoute

boolean

No

Specifies whether to enable the canary release rules for traffic. This rule applies only to applications that use the Spring Cloud and Dubbo frameworks. Valid values:

  • true: enables the canary release rules.

  • false: disables the canary release rules.

false

Php

string

No

The PHP version required by the PHP deployment package. Images are not supported.

PHP-FPM 7.0

AcrInstanceId

string

No

The ACR Enterprise instance ID. This parameter is required when ImageUrl is set to an ACR Enterprise instance image.

cri-xxxxxx

AcrAssumeRoleArn

string

No

The ARN of the RAM role required to pull images across accounts. For more information, see Use RAM roles to authorize access across Alibaba Cloud accounts.

acs:ram::123456789012****:role/adminrole

ImagePullSecrets

string

No

The ID of the corresponding secret.

10

AssociateEip

boolean

No

Specifies whether to associate an elastic IP address (EIP). Valid values:

  • true: associates an EIP.

  • false: does not associate an EIP.

true

KafkaConfigs

string

No

The summary of configurations for collecting logs to Kafka. Valid values:

  • kafkaEndpoint: the service registration address of the Kafka API.

  • kafkaInstanceId: the Kafka instance ID.

  • kafkaConfigs: the summary of configurations for one or more logs. For example values and parameter description, see the kafkaConfigs request parameter in this topic.

{"kafkaEndpoint":"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX","kafkaInstanceId":"alikafka_pre-cn-7pp2l8kr****","kafkaConfigs":[{"logType":"file_log","logDir":"/tmp/a.log","kafkaTopic":"test2"},{"logType":"stdout","logDir":"","kafkaTopic":"test"}]}

PvtzDiscoverySvc

string

No

Enables service registration and discovery for Kubernetes Services. Valid values:

  • portProtocols: the port and protocol. Valid values for the port: 1 to 65535. Valid values for the protocol: TCP and UDP.

  • portAndProtocol: the port and protocol. Valid values for the port: 1 to 65535. Valid values for the protocol: TCP and UDP. Use portProtocols instead. If portProtocols is set, only portProtocols takes effect.

  • enable: enables service registration and discovery for Kubernetes Services.

{"portProtocols":[{"port":18012,"protocol":"TCP"}],"portAndProtocol":{"18012":"TCP"},"enable":true}

SwimlanePvtzDiscoverySvc

string

No

Configures service registration and discovery and end-to-end canary release based on Kubernetes Services:

  • enable: specifies whether to enable the end-to-end canary release feature based on Kubernetes Services.
    • true: enables the feature.

    • false: disables the feature.

  • namespaceId: the ID of the namespace.

  • portAndProtocol: the listening port and protocol. Format: {"port:protocol type":"container port"}.

  • portProtocols: defines the port and protocol of the service.
    • port: the port.

    • protocol: the protocol.

    • targetPort: the container port.

  • pvtzDiscoveryName: service name of the service discovery.

  • serviceId: the ID of the service.

  • serviceName: service name of the service.

{\"enable\":\"false\",\"namespaceId\":\"cn-beijing:test\",\"portAndProtocol\":{\"2000:TCP\":\"18081\"},\"portProtocols\":[{\"port\":2000,\"protocol\":\"TCP\",\"targetPort\":18081}],\"pvtzDiscoveryName\":\"cn-beijing-1421801774382676\",\"serviceId\":\"3513\",\"serviceName\":\"demo-gray.test\"}

MicroRegistration

string

No

The Nacos registry. Valid values:

  • 0: the built-in Nacos of SAE.

  • 1: a self-managed Nacos.

  • 2: Microservices Engine (MSE) Nacos Commercial Edition.

Note

If you select the built-in Nacos of SAE, you cannot obtain the configurations of the built-in Nacos.

"0"

MicroRegistrationConfig

string

No

The registry configurations. This parameter takes effect only when the registry type is MSE Nacos Enterprise Edition.

{\"instanceId\":\"mse-cn-zvp2bh6h70r\",\"namespace\":\"4c0aa74f-57cb-423c-b6af-5d9f2d0e3dbd\"}

NasConfigs

string

No

The configurations for mounting a NAS file system. Valid values:

  • mountPath: the mount path in the container.

  • readOnly: A value of false indicates read and write permissions.

  • nasId: the ID of the NAS file system.

  • mountDomain: the mount target address of the container. For more information, see DescribeMountTargets.

  • nasPath: the relative file directory of the NAS file system.

[{"mountPath":"/test1","readOnly":false,"nasId":"nasId1","mountDomain":"nasId1.cn-shenzhen.nas.aliyuncs.com","nasPath":"/test1"},{"nasId":"nasId2","mountDomain":"nasId2.cn-shenzhen.nas.aliyuncs.com","readOnly":false,"nasPath":"/test2","mountPath":"/test2"}]

Python

string

No

The Python environment. PYTHON 3.9.15 is supported.

PYTHON 3.9.15

PythonModules

string

No

The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root folder are installed. If this parameter is not configured or a custom software package is used, you can specify the dependencies to install.

Flask==2.0

Dotnet

string

No

The version of the .NET framework. Valid values:

  • .NET 3.1

  • .NET 5.0

  • .NET 6.0

  • .NET 7.0

  • .NET 8.0

.NET 3.1

Deploy

string

No

This parameter takes effect only for applications in the stopped state. If a running application calls the DeployApplication operation, the application is immediately redeployed. Valid values:

  • true: the default value. Deploys the application immediately, applies the new deployment configurations, and immediately starts the instances.

  • false: applies only the new deployment configurations without starting the application instances.

true

PackageType

string

No

The type of the application package. Valid values:

  • If you use Java for deployment, valid values are FatJar, War, and Image.

  • If you use PHP for deployment, valid values are:
    • 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

  • If you use Python for deployment, valid values are PythonZip and Image.

FatJar

Cpu

integer

No

The CPU required for each instance. Unit: millicores. The value cannot be 0. Only the following defined specifications are supported:

  • 500

  • 1000

  • 2000

  • 4000

  • 8000

  • 12000

  • 16000

  • 32000

1000

Memory

integer

No

The memory required for each instance. Unit: MB. The value cannot be 0. The memory has a one-to-one mapping with the CPU. Only the following defined specifications are supported:

  • 1024: corresponds to 500 and 1000 millicores.

  • 2048: corresponds to 500, 1000, and 2000 millicores.

  • 4096: corresponds to 1000, 2000, and 4000 millicores.

  • 8192: corresponds to 2000, 4000, and 8000 millicores.

  • 12288: corresponds to 12000 millicores.

  • 16384: corresponds to 4000, 8000, and 16000 millicores.

  • 24576: corresponds to 12000 millicores.

  • 32768: corresponds to 16000 millicores.

  • 65536: corresponds to 8000, 16000, and 32000 millicores.

  • 131072: corresponds to 32000 millicores.

1024

Replicas

integer

No

The number of instances.

1

SecurityGroupId

string

No

The ID of the security group.

sg-wz969ngg2e49q5i4****

VSwitchId

string

No

The vSwitch where the network interface controller (NIC) of the application instance resides. The vSwitch must be located in the preceding VPC.

vsw-bp12mw1f8k3jgygk9****

ServiceTags

string

No

The canary tags configured for the application.

{\"alicloud.service.tag\":\"g1\"}

EnableNewArms

boolean

No

Specifies whether to enable the new ARMS features. Valid values:

  • true: enables the features.

  • false: disables the features.

true

EnableCpuBurst

boolean

No

Specifies whether to enable the CPU Burst feature. Valid values:

  • true: enables the feature.

  • false: disables the feature.

true

OidcRoleName

string

No

The RAM role for the identity authentication service.

Note

You must create an OIDC identity provider and an identity provider role in the same region in advance. For more information, see Create an OIDC identity provider and Create an IdP for role-based SSO.

sae-test

SidecarContainersConfig

array

No

The container configuration information.

SidecarContainerConfig

No

The container configuration information.

SecretMountDesc

string

No

The mount description of the Secret. Uses the secret created on the Secret page of the namespace to inject confidential information into the container. Parameter description:

  • secretId: the instance ID of the secret instance. You can obtain the instance ID by calling the ListSecrets operation.

  • key: the key value.

Note

You can mount all keys by passing the sae-sys-secret-all parameter.

  • mountPath: the mount path.

[{“secretId":10,”key":"test","mountPath":"/tmp"}]

EnableSidecarResourceIsolated

boolean

No

Specifies whether to enable sidecar resource isolation. Valid values:

  • true: enables isolation.

  • false: disables isolation.

true

CustomImageNetworkType

string

No

The custom image network type. If the image is not a custom image, set this parameter to an empty string. Valid values:

  • internet: public image.

  • intranet: private image.

internet

MicroserviceEngineConfig

string

No

Configures microservice governance features.

  • enable: Specifies whether to enable microservice governance. Valid values:
    • true: Enabled.

    • false: Disabled.

  • mseLosslessRule: Configures lossless online and offline rules.
    • delayTime: The delay time.

    • enable: Specifies whether to enable the lossless online feature. Valid values:
      • true: Enabled.

      • false: Disabled.

    • notice: Specifies whether to enable the notification feature. Valid values:
      • true: Enabled.

      • false: Disabled.

    • warmupTime: The warm-up duration for low traffic, in seconds.

{"enable": true,"mseLosslessRule": {"delayTime": 0,"enable": false,"notice": false,"warmupTime": 120}}

NewSaeVersion

string

No

The application edition. Valid values:

  • lite: Lite Edition.

  • std: Standard Edition.

  • pro: Professional Edition.

pro

InitContainersConfig

array

No

The init container configuration.

InitContainerConfig

No

The init container configuration.

GpuConfig

string

No

The GPU configuration.

{ "gpuType":"PPU810E", "gpuCount":"1" }

StartupProbe

string

No

Enables application startup probing.

  • Check succeeded: indicates that the application is started. If you configure liveness and readiness probes, the liveness and readiness probes are executed after the application is started.

  • Check failed: indicates that the application fails to start. An exception is reported and the application is automatically restarted.

Note

Note

  • The exec, httpGet, and tcpSocket methods are supported. For specific examples, refer to the Liveness parameter.

  • You can select only one method for health checks.

{"exec":{"command":["sh","-c","cat /home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}

EnablePrometheus

boolean

No

Specifies whether to enable Prometheus custom metric collection.

false

Html

string

No

The NGINX version. Valid values:

  • nginx 1.20

  • nginx 1.22

  • nginx 1.24

  • nginx 1.26

  • nginx 1.28

nginx 1.28

EmptyDirDesc

string

No

The shared ephemeral storage configuration.

[{\"name\":\"workdir\",\"mountPath\":\"/usr/local/tomcat/webapps\"}]

AlbIngressReadinessGate

string

No

The Application Load Balancer (ALB) gateway readiness gate configuration.

default

MaxSurgeInstances

integer

No

The maximum number of surge instances. Note the following rules:

If the minimum number of available instances is 100%, the Peak Volume Settings cannot be 0. If the Settings are -1, the maximum number of surge instances uses the recommended Peak Volume ratio of 30%, which is 30% of the current number of instances. For example, if the current number of instances is 10, the maximum number of surge instances is 10 × 30% = 3.

-1

MaxSurgeInstanceRatio

integer

No

The maximum surge instance ratio. Note the following rules:

If the minimum number of available instances is 100%, the Peak Volume Settings cannot be 0. If the Settings are -1, the system uses the recommended value of 30%, which is 30% of the current number of instances. For example, if the current number of instances is 10, the maximum number of surge instances is 10 × 30% = 3.

-1

AgentVersion

string

No

The AliyunAgent version.

4.4.2

EnableNamespaceAgentVersion

boolean

No

Specifies whether to reuse the agent version configuration of the namespace.

true

SlsLogEnvTags

string

No

sls log tags

[]

LokiConfigs

string

No

LokiConfigs

[]

Labels

object

No

The application labels. Both keys and values are strings.

string

No

The label.

prod

RaspConfig

object

No

The application runtime security protection (RASP) configuration.

EnableRasp

boolean

No

Specifies whether the application runtime security protection (RASP) is enabled.

RaspAppName

string

No

The RASP application name.

sae-test

RaspAppKey

string

No

The RASP application key.

key-1

Response elements

Element

Type

Description

Example

object

The deployed application information.

RequestId

string

The request ID.

01CF26C7-00A3-4AA6-BA76-7E95F2A3***

Message

string

The additional information. Valid values:

  • If the request is normal, success is returned.

  • If the request is abnormal, a specific error code is returned.

success

TraceId

string

The trace ID, which is used to accurately query call information.

ac1a0b2215622246421415014e****

Data

object

The returned result.

ChangeOrderId

string

The returned change order ID, which is used to query the task execution status.

01db03d3-3ee9-48b3-b3d0-dfce2d88****

AppId

string

The application ID.

7171a6ca-d1cd-4928-8642-7d5cfe69****

IsNeedApproval

boolean

Specifies whether the change publish by a Resource Access Management (RAM) user requires approval. Valid values:

  • true: Approval is required.

  • false: Approval is not required.

true

ErrorCode

string

The error code. Valid values:

  • If the request is successful, the ErrorCode parameter is not returned.

  • If the request fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.

Application.MissingJdk

Code

string

The API status code or POP error code. Valid values:

  • 2xx: Success.

  • 3xx: Redirection.

  • 4xx: Client error.

  • 5xx: Server error.

200

Success

boolean

Indicates whether the application deployment is successful. Valid values:

  • true: The deployment is successful.

  • false: The deployment fails.

true

Examples

Success response

JSON format

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3***",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "Data": {
    "ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88****",
    "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
    "IsNeedApproval": true
  },
  "ErrorCode": "Application.MissingJdk",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 Application.MissingJdk Your application must at least contain a JDK component. The application must contain at least a JDK component.
400 InvalidApplication.NotFound The current application does not exist. The current application cannot be found.
400 InvalidComponent.NotFound The current component (such as JDK, Tomcat, or EDASWebContainer) does not exist. The specified component (JDK, Tomcat, EDASWebContainer, etc.) cannot be found.
400 InvalidHostnameIp.Invalid The hostname and/or IP is invalid: Hostname [%s], IP [%s]. The hostname or IP address is invalid: hostname [%s], IP [%s].
400 InvalidInstanceSpecification.Unsupported The instance specification is not supported: CPU [%s], memory [%s]. The instance type is not supported. CPU [%s], Memory [%s].
400 InvalidPackageType.NotFound The package type must be War, FatJar, or Image. The package type must be WAR, FatJAR, or Image.
400 InvalidParameter.NotEmpty You must specify the parameter %s. Invalid parameter: %s cannot be empty.
400 InvalidParameter.Obviously The specified parameter is invalid {%s}. Invalid parameter {%s}.
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s Invalid parameter {%s}: %s.
400 JarApplication.MissingJdk A FatJar application must contain JDK. FatJar applications must include a JDK.
400 NoComputeResourceQuota.Exceed Your compute resource is insufficient. Please contact us to raise the quota.
400 PandoraApplication.MissingJdk The Pandora application is missing a JDK component. The Pandora application is missing the JDK component.
400 PandoraApplication.OnlyJdk A Pandora application only requires JDK component. The Pandora application requires only the JDK component.
400 WarApplication.MissingJdkWebcontainer A War application must contain JDK and Tomcat. WAR-type applications must include JDK and Tomcat.
400 LogService.ConfigQuotaExceed The maximum number of Log Service configs is exceeded. The maximum number of Log Service configs is exceeded, please join the DingTalk group 32874633 for technical support.
400 LogService.InternalError An exception occurred while calling Log Service. Please submit a ticket to solve the problem. An exception occurred while calling log service. please join the DingTalk group 32874633 for technical support.
400 LogService.LogDirInvalid The log collection path is invalid. The log collection path is invalid.
400 LogService.NotAvailable Log Service is unavailable. Please activate Log Service first. The log service is not available. Please open the log service first.
400 LogService.ProjectNumQuotaExceed The maximum number of Log Service projects is exceeded. The maximum number of Log Service projects is exceeded, please join the DingTalk group 32874633 for technical support.
400 user.indebt The user has an outstanding payment. The current user has an overdue payment.
400 NoComputeResourceQuota.App.Exceed You can create %s instances for each application. Please submit a ticket to raise the quota. You can create %s instances for each application. please join the DingTalk group 32874633 for technical support.
400 NoComputeResourceQuota.User.Exceed Your account is limited to create %s instances. Please submit a ticket to raise the quota. Your account is limited to create %s instances. please join the DingTalk group 32874633 for technical support.
400 System.Upgrading The system is being upgraded. Please try again later. The system is being upgraded. Try again later.
400 VolumnPath.Conflict Conflict between log collection directory and persistent storage directory. Conflict between log collection directory and persistent storage directory.
400 Application.ChangerOrderRunning An application change process is in progress. Please try again later. An application change process is in progress. Please try again later.
400 Application.InvalidStatus The application status is abnormal. Please try again later. The application status is abnormal. Please try again later.
400 MountConflict.ConfigMap Conflict detected for ConfigMap path %s. The ConfigMap mount path %s conflicts with an existing path.
400 NotFound.ConfigMap The ConfigMap object (ID: %s) does not exist. The ConfigMap object (ID=%s) was not found.
400 NotFound.ConfigMapKey The key %s of ConfigMap object (ID: %s) does not exist. The key %s of the ConfigMap object (ID=%s) was not found.
400 Package.Version.Too.Long The maximum length of package version is exceeded. This package version is too long.
400 App.Package.Version.Exists The package version of application already exists. The package version of application already exists.
400 Slb.Occupied The SLB instance is occupied. This SLB is occupied.
400 Slb.Tag.Not.Qualified The current SLB instance cannot be reused because it may have been occupied by %s. The current SLB instance cannot be reused because it may have been occupied by %s.
400 MinReadyInstances.Not.Smaller.Replicas The minimum number of available instances must be less than the number of application instances. The minimum number of available instances must be less than the number of application instances.
400 MinReadyInstanceRatio.Invalid The ratio of minimum available instances must be between 0 and 100. The minimum surviving instance ratio must be between 0 and 100.
400 BatchWaitTime.Not.Smaller.Zero BatchWaitTime must not be smaller than zero. BatchWaitTime must not be smaller than zero.
400 Sls.Config.Mixed.Multi.Project The specified Config contains multiple projects. The SLS configuration that you specified contains multiple projects.
400 Sls.Config.User.Defined.Missing.Logstore.Info The specified Config is invalid. Both Project and Logstore must be specified. The SLS configuration that you specified is a custom SLS configuration, but it contains only the Project configuration. The Logstore configuration is missing.
400 Sls.Config.User.Defined.Missing.Project.Info The specified Config is invalid. Both Project and Logstore must be specified. The SLS configuration that you specified is a custom SLS configuration, but it contains only the Logstore configuration. The Project configuration is missing.
400 Sls.Logstore.Name.Invalid The specified name of Logstore is invalid. The Logstore name must not contain the prefix "sae-". The SLS Logstore name that you specified is invalid. The name contains the prefix "sae-", which causes obfuscation with Logstores that are subject to automatic creation by SAE.
400 Sls.Logstore.User.Defined.Not.Exist The user defined Logstore does not exist. The custom Logstore that you specified does not exist.
400 Sls.Project.Name.Invalid The specified project name is invalid. The project name must not contain the prefix "sae-". The SLS Project name that you specified is invalid. The name contains the prefix "sae-", which causes obfuscation with projects that are subject to automatic creation by SAE.
400 Sls.Project.User.Defined.Not.Exist The user defined project does not exist. The custom project that you specified does not exist.
400 Sae.Errorcode.Ahas.Create.Error.Message Failed to create AHAS. Failed to create AHAS.
400 InvalidImageUrl.AcrInstanceId.Domain.NotMatch The specified domain of ImageUrl does not match AcrInstanceId domains. The domain name of the specified ImageUrl does not match the domain name of the AcrInstanceId.
400 PhpApplication.MissingPhpRuntime A PHP application must contain PHP Runtime. A PHP application must include the PHP runtime.
400 InvalidParameter.FileName The application deployment package name is invalid. This name can contain only alphanumeric characters, hyphens (-), and underscores (_). For deploying java package, you can upload JAR files only if the selected deployment version supports JAR file. Otherwise, upload WAR files only. For deploying php package, you can upload ZIP files only if the selected deployment version supports ZIP file. The application deployment program package name is invalid. The name can contain only letters, digits, and special characters "-" and "_". For Java package deployment, you can upload a JAR package only when the selected deployment version supports JAR deployment. Otherwise, you can upload only a WAR package. For PHP package deployment, you can upload a ZIP package only when the selected deployment version supports ZIP deployment.
400 Sls.Logtail.Name.Invalid The specified name of Logtail is invalid. The Logtail name must not contain the prefix sae-. The SLS Logtail name that you specified is invalid. The name contains the prefix "sae-", which causes obfuscation with Logtails that are subject to automatic creation by SAE.
400 InvalidImageUrl.MissingAcrInstanceId The specified domain of ImageUrl is from ACREE, but you are not specified AcrInstanceId. The domain name of the specified ImageUrl belongs to Container Registry Enterprise Edition (ACREE), but the AcrInstanceId is not specified.
400 EnvFromSecretIdConflict.AlreadyExist The specified SecretId [%s] already exist in the specified Envs. The specified secret [%s] already exists in the environment variables.
400 MountConflict.Secret Conflict detected for Secret path %s. Secret mount path% s has conflict.
404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist. The specified NamespaceId does not exist.
404 InvalidAcrInstanceId.NotFound The specified AcrInstanceId does not exist. The specified AcrInstanceId does not exist.
404 Associate.Eip.Not.Enough No sufficient EIPs are available. Insufficient elastic IP addresses (EIPs) are available for binding. Purchase EIPs first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.