Serverless App Engine:DescribeApplicationConfig

VPC ID.

Application startup status check. Containers that fail multiple health checks will be shut down and restarted. Containers that fail the readiness check will not receive traffic from SLB. Supported methods include exec, httpGet, and tcpSocket. For examples, see the Liveness parameter.

Security group ID.

Waiting time between batches during phased release, in seconds.

JDK version required by the deployment package. Supported versions:

• Open JDK 8

• Open JDK 7

• Dragonwell 11

• Dragonwell 8

• openjdk-8u191-jdk-alpine3.9

• openjdk-7u201-jdk-alpine3.9

Not supported when Package Type is Image.

Image address. Required when Package Type is Image.

Configuration for log collection to 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 descriptions:

• projectName: Project name in SLS.

• logDir: Log path.

• logType: Log type. stdout indicates container standard output logs. Only one entry can be set. If not specified, file logs are collected.

• logstoreName: Logstore name in SLS.

• logtailName: Logtail name in SLS. If not specified, a new Logtail is created.

If the SLS collection configuration does not change during redeployment, you do not need to set this parameter (omit the SlsConfigs field in the request). If you no longer need SLS collection, set this field to an empty string (SlsConfigs = "").

Container health check. Containers that fail the liveness check will be shut down and recovered. Supported methods:

• 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}

Parameter descriptions:

• exec.command: Set the health check command.

• httpGet.path: Access path.

• httpGet.scheme: HTTP or HTTPS.

• httpGet.isContainKeyWord: true means the response contains the keyword. false means it does not. If omitted, advanced features are not used.

• httpGet.keyWord: Custom keyword. The isContainKeyWord field must be present when using this.

• tcpSocket.port: Port for TCP connection detection.

• initialDelaySeconds: Delay before the first health check. Default is 10 seconds.

• periodSeconds: Interval between health checks. Default is 30 seconds.

• timeoutSeconds: Timeout for health checks. Default is 1 second. If set to 0 or omitted, the default timeout is 1 second.

Deployment package URL. If your package was uploaded through SAE, note the following:

• This URL cannot be downloaded directly. Use the GetPackageVersionAccessableUrl API to get a downloadable URL (valid for 10 minutes).

• SAE retains the package for up to 90 days. After 90 days, the URL is no longer returned and downloads are unavailable.

Application package type. Values:

• For Java deployments: FatJar, War, and Image.

• For PHP deployments:

  • 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

Script executed before container termination. Runs before the container is deleted. Format: {"exec":{"command":["cat","/etc/group"]}}

Deployment package version. Required when Package Type is FatJar or War.

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

Application name.

Application ID.

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

Number of application instances.

Deployment strategy. When the minimum number of ready instances is 1, UpdateStrategy is "". When greater than 1, examples:

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

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

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

Parameter descriptions:

• type: Release strategy type. Options: canary release GrayBatchUpdate or phased release BatchUpdate.

• batchUpdate: Phased release strategy.

  • batch: Number of release batches.

  • releaseType: Batch processing method. Options: auto auto or manual manual.

  • batchWaitTime: Time between batches, in seconds.

• grayUpdate: Instances after canary phase. Required when type is GrayBatchUpdate.

Minimum number of ready instances. Values:

• If set to 0, the application will experience service interruption during upgrades.

• If set to -1, the system uses its recommended value (25% of current instances). For example, with 5 instances: 5 × 25% = 1.25 → rounded up to 2.

Percentage of minimum ready instances. Values:

• -1: Default value. Percentage is not used. If omitted, defaults to -1.

• 0~100: Percentage value, rounded up. For example, 50% with 5 instances → 3 ready instances.

Memory required per instance, in MB. Cannot be 0. Must match CPU specifications. Supported fixed specifications:

• 1024: Corresponds to 500 or 1000 millicores CPU.

• 2048: Corresponds to 500, 1000, or 2000 millicores CPU.

• 4096: Corresponds to 1000, 2000, or 4000 millicores CPU.

• 8192: Corresponds to 2000, 4000, or 8000 millicores CPU.

• 12288: Corresponds to 12000 millicores CPU.

• 16384: Corresponds to 4000, 8000, or 16000 millicores CPU.

• 24576: Corresponds to 12000 millicores CPU.

• 32768: Corresponds to 16000 millicores CPU.

• 65536: Corresponds to 8000, 16000, or 32000 millicores CPU.

• 131072: Corresponds to 32000 millicores CPU.

PHP version required by the deployment package. Not supported for images.

PHP configuration file content.

Mount path for PHP application startup configuration. Ensure the PHP server uses this configuration file at startup.

Script executed after container startup. Runs immediately after the container is created. Format: {"exec":{"command":["cat","/etc/group"]}}

Graceful shutdown timeout. Default is 30 seconds. Range: 1–300 seconds.

Image startup command arguments. Arguments for the Command parameter. Format:

["a","b"]

In the Command example, CommandArgs=["abc", ">", "file0"] must be converted to a JSON array string. Omit if not needed.

Namespace ID.

NAS mount point within the application VPC. If the configuration hasn't changed during deployment, omit this parameter. To clear NAS configuration, set this field to an empty string ("").

Tomcat configuration. Set to "" or "{}" to delete configuration:

• port: Port range 1024–65535. Ports below 1024 require root privileges. Since containers run as admin, use ports above 1024. Default: 8080.

• contextPath: Access path. Default: root directory "/".

• maxThreads: Connection pool size. Default: 400.

• uriEncoding: Tomcat encoding format. Options: UTF-8, ISO-8859-1, GBK, GB2312. Default: ISO-8859-1.

• useBodyEncoding: Whether to use BodyEncoding for URL. Default: true.

Region ID.

vSwitch ID.

CPU required per instance, in millicores. Cannot be 0. Supported fixed specifications:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

Container environment variables. Supports custom values or ConfigMap references. To reference a ConfigMap, create a ConfigMap instance first. For more information, see CreateConfigMap. Values:

• Custom configuration

  • name: Environment variable name.

  • value: Environment variable value.

• ConfigMap reference

  • name: Environment variable name. To reference all keys, use sae-sys-configmap-all-<ConfigMap name>, for example sae-sys-configmap-all-test1.

  • valueFrom: Environment variable reference. Value: configMapRef.

  • configMapId: ConfigMap ID.

  • key: Key. Omit if referencing all keys.

Whether to integrate with AHAS. Values:

• true: Integrate with AHAS.

• false: Do not integrate with AHAS.

Custom host mapping inside the container. Values:

• hostName: Domain name or hostname.

• ip: IP address.

Tomcat version required by the deployment package. Supported versions:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

Not supported when Package Type is Image.

Image startup command. Must be an executable object inside the container. Example:

command:
      - echo
      - abc
      - >
      - file0

Based on this example: Command="echo", CommandArgs=["abc", ">", "file0"].

WAR package startup options. Default startup command: java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start.

Mount path for PHP application monitoring configuration. Ensure the PHP server loads this configuration file.

You don't need to manage the configuration content. SAE automatically renders the correct configuration file.

NAS ID.

OSS read/write AccessKey ID.

OSS read/write AccessKey secret.

Application runtime environment version in the HSF framework, such as Ali-Tomcat container.

Time zone. Default: Asia/Shanghai.

Application description.

Whether to enable traffic grayscale rules. Applies only to Spring Cloud and Dubbo applications. Values:

• true: Enable grayscale rules.

• false: Disable grayscale rules.

MSE product-side application ID.

ACR Enterprise Edition instance ID.

ARN of the RAM role required for cross-account image pulling. For more information, see Pull Alibaba Cloud images across accounts and Authorize across cloud accounts using RAM roles.

Corresponding secret ID.

Whether to bind an EIP. Values:

• true: Bind.

• false: Do not bind.

Aggregated configuration for log collection to Kafka. Values:

• kafkaEndpoint: Service endpoint for Kafka API.

• kafkaInstanceId: Kafka instance ID.

• kafkaConfigs: Aggregated configuration for single or multiple logs. For examples and parameter descriptions, see the request parameter kafkaConfigs in this topic.

Technology stack language for application creation. Values:

• java: Java.

• php: PHP.

• other: Multi-language, such as Python, C++, Go, .NET, and Node.js.

Enable K8s Service registration and discovery.

Configure K8s Service registration and discovery with end-to-end canary release.

Select Nacos registry. Values:

• 0: Built-in Nacos in SAE.

• 1: Self-managed Nacos.

• 2: MSE commercial Nacos.

NAS mount configuration.

Python environment. Supports PYTHON 3.9.15.

Custom module dependencies. By default, dependencies defined in requirements.txt in the root directory are installed. If not configured or using custom packages, specify the dependencies to install.

Application name after SAE registers with MSE.

SAE application type.

• micro_service.

• web.

• job.

.NET framework version:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

Registry configuration. Only effective when the registry type is MSE Nacos Enterprise Edition.

Whether to enable idle mode:

• true: Enable

• false: Disable

Whether to enable the new ARMS feature:

• true: Enable

• false: Disable

Whether to enable CPU Burst:

• true: Enable

• false: Disable

Set the RAM role for identity authentication.

Custom image type. Set to an empty string if not a custom image:

• internet: Public network image

• intranet: Private network image

Resource type. Only supports application.

Baseline application ID.

Configure microservice governance features.

• Enable microservice governance (enable):

  • true: Enable

  • false: Disable

• Configure graceful start and shutdown (mseLosslessRule):

  • delayTime: Delay time

  • enable: Whether to enable graceful start. true to enable, false to disable.

  • notice: Whether to enable notification. true to enable, false to disable.

  • warmupTime: Warm-up duration for small traffic, in seconds.

Application version:

• lite: Lite edition

• std: Standard edition

• pro: Professional edition

Cluster ID.

Disk storage size (in GB).

Application startup probe.

sls log env tags