Serverless App Engine:DescribeApplicationConfig

VPC ID。

The application startup status check. Containers that fail multiple health checks are shut down and restarted. Containers that do not pass the health check do not receive SLB traffic. The exec, httpGet, and tcpSocket methods are supported. For specific examples, see the Liveness parameter.

The security group ID.

The wait time between batches during a phased release, in seconds.

The JDK version on which the deployment package depends. 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.

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

The settings for log collection to Simple Log Service (SLS).

• To use SLS resources that are automatically created by Serverless App Engine (SAE): [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

• To 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: The name of the project in SLS.

• logDir: The log path.

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

• logstoreName: The name of the Logstore in SLS.

• logtailName: The name of the Logtail in SLS. If this parameter is not specified, a new Logtail is created through automatic creation.

If the SLS collection configuration has not changed during multiple deployments, you do not need to set this parameter (that is, the SlsConfigs field does not need to be included in the request). If you no longer need the SLS collection feature, set the value of this field to an empty string in the request (that is, set the value of the SlsConfigs field to "").

The container health check settings. Containers that fail the health check are shut down and recovered. The following 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}

Parameter descriptions:

• 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. 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 must be present when this parameter is used.

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

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

• periodSeconds: The health check period. Default value: 30. Unit: seconds.

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

The deployment package URL. If your deployment package is uploaded through SAE, note the following:

• This URL cannot be used for direct download. Use the GetPackageVersionAccessableUrl operation to obtain a downloadable URL (valid for 10 minutes).

• SAE retains the package for a maximum of 90 days. After 90 days, the URL is no longer returned and the package is no longer available for download.

The application package type. Valid values:

• When you deploy with Java, FatJar, War, and Image are supported.

• When you deploy with PHP, the following types 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 run before the container stops. A script is triggered before the container is deleted. Format: {"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 application. The default startup command for the application: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

The application name.

The application ID.

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

The number of application instances.

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

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

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

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

Parameter descriptions:

• type: The release policy type. Valid values: GrayBatchUpdate (grayscale batch release) and BatchUpdate (batch release).

• batchUpdate: The batch release policy.

  • batch: The number of release batches.

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

  • batchWaitTime: The interval between deployments within a batch, in seconds.

• grayUpdate: The remaining batches after grayscale release. This parameter is required when type is set to GrayBatchUpdate.

The minimum number of available instances. Valid values:

• If set to 0, the application interrupts services during the upgrade process.

• If set to -1, the system-recommended value is used, which is 25% of the current number of instances. If the current number of instances is 5, 5 × 25% = 1.25, which is rounded up to 2.

The minimum percentage of available instances. Valid values:

• -1: The default value, which indicates that the percentage is not used. If this parameter is not specified, the system uses -1 by default.

• 0~100: The unit is percentage, rounded up. For example, if set to 50%, and the current number of instances is 5, the minimum number of available instances is 3.

The memory size required by each instance, in MB. This value cannot be 0. The memory size has a one-to-one mapping with CPU. Only the following defined specifications are supported:

• 1024: Corresponds to 500 millicores and 1000 millicores of CPU.

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

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

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

• 12288: Corresponds to 12000 millicores of CPU.

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

• 24576: Corresponds to 12000 millicores of CPU.

• 32768: Corresponds to 16000 millicores of CPU.

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

• 131072: Corresponds to 32000 millicores of CPU.

The PHP version on which the PHP deployment package depends. Images are not supported.

The content of the PHP configuration file.

The mount path of the PHP application startup configuration. Make sure that the PHP server uses this configuration file for startup.

The script that is run after the container starts. A script is triggered immediately after the container is created. Format: {"exec":{"command":\["cat","/etc/group"\]}}

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

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

["a","b"]

In the example for the Command parameter, CommandArgs=["abc", ">", "file0"], where ["abc", ">", "file0"] must be converted to the String type and the internal format is a JSON array. If this parameter is not required, leave it empty.

The namespace ID.

The mount point of NAS within the application VPC. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the MountHost field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string in the request (that is, set the value of the MountHost field to "").

The Tomcat configuration. Set this parameter to "" or "{}" to delete the configuration:

• port: The port number. Valid values: 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with admin permissions, specify a port greater than 1024. Default value: 8080.

• contextPath: The access path. Default value: 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. Default value: ISO-8859-1.

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

The region ID.

vSwitch ID。

The CPU required by each instance, in millicores. This value cannot be 0. Only the following defined specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The container environment variable parameters. Custom values or references to configuration items are supported. To reference a configuration item, create a ConfigMap instance first. For more information, see CreateConfigMap. Valid values:

• Custom configuration

  • name: The environment variable name.

  • value: The environment variable value.

• Reference to a configuration item

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

  • configMapId: The ConfigMap ID.

  • key: The key. If all keys are referenced, do not set this field.

Specifies whether to connect to Application High Availability Service (AHAS). Valid values:

• true: Connected to AHAS.

• false: Not connected to AHAS.

The custom host mapping in the container. Valid values:

• hostName: The domain name or hostname.

• ip: The IP address.

The Tomcat version on which the deployment package depends. Valid values:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

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

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

command:
      - echo
      - abc
      - >
      - file0

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

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

The mount path for PHP application monitoring. Make sure that the PHP server loads the configuration file from this path.

You do not need to manage the configuration content. SAE automatically renders the correct configuration file.

NAS ID。

The AccessKey ID for OSS read/write operations.

The AccessKey Secret for OSS read/write operations.

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

The time zone. Default value: Asia/Shanghai.

The application description.

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

• true: Enabled.

• false: Disabled.

The application ID on the Microservices Engine (MSE) side.

The ACR Enterprise instance ID.

The ARN of the RAM role required for pulling images across accounts. For more information, see Pull Alibaba Cloud images across accounts and Grant cross-account permissions by using RAM roles.

The corresponding secret ID.

Specifies whether to associate an EIP. Valid values:

• true: Associated.

• false: Not associated.

The summary of log collection configurations for Kafka. Valid values:

• kafkaEndpoint: The endpoint of the Kafka API.

• kafkaInstanceId: The Kafka instance ID.

• kafkaConfigs: The configuration summary for one or more log entries. For example values and parameter descriptions, see the kafkaConfigs request parameter in this topic.

The programming language of the technology stack used to create the application. Valid values:

• java: Java.

• php: PHP.

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

Enables K8s Service-based service registration and discovery.

Configures K8s Service-based service registration and discovery with end-to-end canary release.

The Nacos registry. Valid values:

• 0: SAE built-in Nacos.

• 1: Self-managed Nacos.

• 2: MSE commercial edition Nacos.

The NAS mount configurations.

The Python environment. PYTHON 3.9.15 is supported.

The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root directory are installed. If no dependencies are configured or custom packages are needed, you can specify the dependencies to install.

The application name after the SAE service is registered with MSE.

The SAE application type.

• micro_service

• web

• job

The .NET framework version:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

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

Specifies whether to enable idle mode. Valid values:

• true: Enabled.

• false: Disabled.

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

• true: Enabled.

• false: Not enabled.

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

• true: Enabled.

• false: Not enabled.

The RAM role for identity authentication.

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

• internet: public image

• intranet: internal image

The resource type. Only application is supported.

The ID of the baseline application.

The microservice governance configuration.

• Specifies whether to enable microservice governance (enable):

  • true: enabled

  • false: disabled

• Lossless rolling update configuration (mseLosslessRule):

  • delayTime: the delay time.

  • enable: specifies whether to enable the lossless online feature. true indicates enabled. false indicates disabled.

  • notice: specifies whether to enable the notification feature. true indicates enabled. false indicates disabled.

  • warmupTime: the warm-up duration for traffic ramping, in seconds.

The application version. Valid values:

• lite: Lite Edition

• std: Standard Edition

• pro: Professional Edition

The cluster ID.

The disk storage size, in GB.

The startup probe of the application.

The number of GPUs.

The GPU type.

Indicates whether Prometheus custom metric collection is enabled.

Indicates whether the application is stateful.

The CloudMonitor service ID.

The instance name of the application in the ASI cluster.

The ALB gateway ReadinessGate configuration.

The Peak Volume of instances.

The Peak Volume instance ratio.

The agent version.

Indicates whether the namespace agent version configuration is reused.

sls log env tags

LokiConfigs