Serverless App Engine:DescribeApplicationConfig

The ID of the VPC.

The readiness probe of the application. A container that fails the health check multiple times is stopped and restarted. A container that fails the health check does not receive traffic from SLB. The exec, httpGet, and tcpSocket check methods are supported. For more information about the examples, see the Liveness parameter.

The ID of the security group.

The wait time between batches for a phased release. Unit: seconds.

The JDK version that is required by the deployment package. The following versions are supported:

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

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

The configurations of log collection for SLS.

• If you use an SLS resource that is automatically created by SAE: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

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

The following parameters are included:

• projectName: The name of the SLS project.

• logDir: The path of the log.

• logType: The log type. stdout specifies the standard output log of the container. You can specify only one standard output log. If you do not configure this parameter, file logs are collected.

• logstoreName: The name of the Logstore in SLS.

• logtailName: The name of the Logtail in SLS. If you do not specify this parameter, a new Logtail is created.

If the SLS log collection configuration is not changed during a deployment, you do not need to set this parameter. If you no longer need to use the SLS log collection feature, you must set this parameter to an empty string ("") in the request.

The liveness health check of the container. A container that fails the health check is stopped and restored. The following check methods are supported:

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

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

• tcpSocket: For example, {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

The following parameters are included:

• exec.command: 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 you do not specify this parameter, the advanced feature is not used.

• httpGet.keyWord: The custom keyword. The isContainKeyWord parameter must be specified.

• tcpSocket.port: The port that is used for the TCP connection check.

• initialDelaySeconds: The startup delay for the health check. Default value: 10. Unit: seconds.

• periodSeconds: The interval for the health check. Default value: 30. Unit: seconds.

• timeoutSeconds: The timeout period of the health check. Default value: 1. Unit: seconds. If you set this parameter to 0 or do not specify this parameter, the default timeout period is 1 second.

The URL of the deployment package. If you uploaded the deployment package using SAE, note the following points:

• This URL cannot be used to download the package. You must call the GetPackageVersionAccessableUrl operation to obtain a download URL that is valid for 10 minutes.

• SAE stores the package for a maximum of 90 days. After 90 days, the URL is not returned and the package cannot be downloaded.

The type of the application package. Valid values:

• If you use a Java package, FatJar, War, and Image are supported.

• If you use a PHP package, the following values are supported:

  • 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

The script that is executed before the container is stopped. The script is executed before the container is deleted. Example: {"exec":{"command":\["cat","/etc/group"\]}}

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

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

The application name.

The application ID.

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

The number of application instances.

The deployment policy. If the minimum number of surviving instances is 1, the value of UpdateStrategy is an empty string. If the minimum number of surviving instances is greater than 1, the following examples are applicable:

• One-instance canary release, followed by a two-batch release with an interval of one minute between batches: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

• One-instance canary release, followed by a two-batch release that requires manual confirmation: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

• Two-batch release with an interval of zero minutes between batches: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

The following parameters are included:

• type: The type of the release policy. Valid values: GrayBatchUpdate (canary release) and BatchUpdate (phased release).

• batchUpdate: The phased release policy.

  • batch: The number of release batches.

  • releaseType: The processing method between batches. Valid values: auto and manual.

  • batchWaitTime: The interval between batches. Unit: seconds.

• grayUpdate: The number of remaining batches after the canary release. This parameter is required when type is set to GrayBatchUpdate.

The minimum number of surviving instances. Valid values:

• If you set this parameter to 0, the application may be unavailable during the upgrade.

• If you set this parameter to -1, the minimum number of surviving instances is determined by the system. The value is 25% of the current number of instances. For example, if you have five instances, the minimum number of surviving instances is 5 × 25% = 1.25, which is rounded up to 2.

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

• -1: This is the default value. It indicates that the percentage is not used. If you do not specify this parameter, the default value -1 is used.

• 0 to 100: The value is a percentage that is rounded up. For example, if you set the value to 50% and you have five instances, the minimum number of surviving instances is 3.

The memory required by each instance. Unit: MB. This parameter cannot be 0. It must correspond to the CPU specifications. The following specifications are supported:

• 1024: corresponds to 500 and 1,000 millicores of CPU.

• 2048: corresponds to 500, 1,000, and 2,000 millicores of CPU.

• 4096: corresponds to 1,000, 2,000, and 4,000 millicores of CPU.

• 8192: corresponds to 2,000, 4,000, and 8,000 millicores of CPU.

• 12288: corresponds to 12,000 millicores of CPU.

• 16384: corresponds to 4,000, 8,000, and 16,000 millicores of CPU.

• 24576: corresponds to 12,000 millicores of CPU.

• 32768: corresponds to 16,000 millicores of CPU.

• 65536: corresponds to 8,000, 16,000, and 32,000 millicores of CPU.

• 131072: corresponds to 32,000 millicores of CPU.

The PHP version that is required for the PHP deployment package. This parameter is not supported for images.

The content of the PHP configuration file.

The mount path of the PHP application startup configuration. You must make sure that the PHP server uses this configuration file to start.

The script that is executed after the container is started. The script is executed immediately after the container is created. Example: {"exec":{"command":\["cat","/etc/group"\]}}

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

The arguments of the startup command. The arguments are required by the Command parameter. Example:

["a","b"]

In the example of the Command parameter, CommandArgs=["abc", ">", "file0"]. The value ["abc", ">", "file0"] must be a JSON array that is converted into a string. If you do not need to specify this parameter, leave it empty.

The namespace ID.

The mount target of the NAS file system in the application's VPC. If the configuration is not changed during a deployment, you do not need to set this parameter. If you want to remove the NAS configuration, set this parameter to an empty string ("") in the request.

The Tomcat file configuration. Set this parameter to an empty string ("") or "{}" to delete the configuration:

• port: The port number. Valid values: 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container has only administrator permissions, you must specify a port that is greater than 1024. If you do not specify this parameter, the default port 8080 is used.

• contextPath: The access path. Default value: /.

• 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 you do not specify this parameter, the default value ISO-8859-1 is used.

• useBodyEncoding: Specifies whether to use BodyEncoding for URL. Default value: true.

The region ID.

The vSwitch ID.

The CPU required by each instance. Unit: millicores. This parameter cannot be 0. The following specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

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

• Custom configuration

  • name: The name of the environment variable.

  • value: The value of the environment variable.

• Reference configuration

  • 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 to the environment variable. Set the value to configMapRef.

  • configMapId: The ID of the ConfigMap.

  • key: The key. If you want to reference all keys, do not specify this parameter.

Specifies whether to enable AHAS. Valid values:

• true: Enable AHAS.

• false: Do not enable AHAS.

The custom mapping between a host and an IP address in the container. Valid values:

• hostName: The domain name or hostname.

• ip: The IP address.

The Tomcat version that is required by the deployment package. The following versions are supported:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

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

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 this example, Command="echo" and CommandArgs=["abc", ">", "file0"].

The options for starting the WAR package. The default startup command is: java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start.

The mount path of the Application Monitoring configuration for the PHP application. You must make sure that the PHP server loads the configuration file from this path.

You do not need to pay attention to the content of the configuration file. SAE automatically renders the correct configuration file.

The NAS ID.

The AccessKey ID that is used to read data from and write data to OSS.

The AccessKey secret that is used to read data from and write data to OSS.

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

The time zone. Default value: Asia/Shanghai.

The description of the application.

Specifies whether to enable the canary release rule. This rule is applicable only to applications that use the Spring Cloud and Dubbo frameworks. Valid values:

• true: Enable the canary release rule.

• false: Disable the canary release rule.

The ID of the application in MSE.

The ID of the Container Registry Enterprise Edition instance.

The ARN of the RAM role that is required to pull images across accounts. For more information, see Pull images across accounts and Create a RAM role for a trusted Alibaba Cloud account.

The ID of the secret.

Specifies whether to bind an EIP. Valid values:

• true: Bind an EIP.

• false: Do not bind an EIP.

The configurations of log collection for Kafka. Valid values:

• kafkaEndpoint: The endpoint of the Kafka API.

• kafkaInstanceId: The ID of the Kafka instance.

• kafkaConfigs: The configurations of one or more logs. For more information about the example and parameters, see the kafkaConfigs request parameter in this topic.

The programming language of the application. Valid values:

• java: Java

• php: PHP

• other: other languages, such as Python, C++, Go, .NET, and Node.js.

Enable service registration and discovery for the Kubernetes Service.

Configure service registration and discovery and end-to-end canary release based on the Kubernetes Service.

The Nacos registry. Valid values:

• 0: SAE built-in Nacos.

• 1: User-created Nacos.

• 2: MSE Nacos Enterprise Edition.

The configurations for mounting the NAS file system.

The Python environment. PYTHON 3.9.15 is supported.

The dependencies of custom installation modules. By default, the dependencies defined in the requirements.txt file in the root directory are installed. If no custom package is configured, you can specify the dependencies to be installed.

The name of the application after it is registered with MSE.

The type of the SAE application.

• micro_service.

• web.

• job.

The version of the .NET framework:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

The registry configuration. This parameter is valid only when the registry type is MSE Nacos Enterprise Edition.

Specifies whether to enable the idle mode:

• true: Enable

• false: Disable

Specifies whether to enable the new ARMS feature:

• true: Enable

• false: Disable

Specifies whether to enable the CPU Burst feature:

• true: Enable

• false: Disable

The RAM role of the identity authentication service.

The type of the custom image. If you do not use a custom image, set this parameter to an empty string:

• internet: public image

• intranet: private image

The resource type. Only application is supported.

The ID of the baseline application.

Configure the microservice governance feature.

• Specifies whether to enable microservice governance (enable):

  • true: Enable

  • false: Disable

• Configure graceful start and shutdown (mseLosslessRule):

  • delayTime: The delay event.

  • enable: Specifies whether to enable graceful start. true indicates that graceful start is enabled. false indicates that graceful start is disabled.

  • notice: Specifies whether to enable notifications. true indicates that notifications are enabled. false indicates that notifications are disabled.

  • warmupTime: The warm-up duration for small traffic. Unit: seconds.

The application version:

• lite: Lightweight Edition

• std: Standard Edition

• pro: Professional Edition

The cluster ID.

The disk storage size. Unit: GB.

The startup probe of the application.

The tags of the SLS log environment.