DescribeApplicationConfig

The ID of the virtual private cloud (VPC).

The readiness probe of the application. A container that fails the health check multiple times is shut down and restarted. A container that fails the health check does not receive traffic from a Server Load Balancer (SLB) instance. You can perform the health check using the exec, httpGet, or tcpSocket method. For more information, see the Liveness parameter.

The ID of the security group.

The interval between batches in a phased release. Unit: seconds.

The version of the Java Development Kit (JDK) that the deployment package requires. 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 URL of the image. This parameter is required when Package Type is set to Image.

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

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

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

The parameters are described as follows:

• projectName: The name of the SLS project.

• logDir: The log path.

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

• logstoreName: The name of the Logstore in SLS.

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

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

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

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

The parameters are described as follows:

• exec.command: The command that is used for the health check.

• httpGet.path: The request path.

• httpGet.scheme: HTTP or HTTPS.

• httpGet.isContainKeyWord: Specifies whether the response must contain a keyword. A value of true indicates that the response must contain the keyword. A value of false indicates that the response does not need to contain the keyword. If you do not specify this parameter, this advanced feature is not used.

• httpGet.keyWord: The custom keyword. This parameter is required if you set the isContainKeyWord parameter.

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

• initialDelaySeconds: The 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 for the health check. Default value: 1. Unit: seconds. If you set this parameter to 0 or do not specify this parameter, the default value is used.

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

• You cannot download the package from this URL. 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 you cannot download the package.

The type of the application package. Valid values:

• If you deploy the application using Java, valid values are FatJar, War, and Image.

• If you deploy the application using PHP, 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 runs before the container is stopped. The script runs 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 ready instances is 1, the value of the UpdateStrategy parameter is "". If the minimum number of ready instances is greater than 1, see the following examples:

• Canary release of one instance, phased release in two batches, automatic batching, and a 1-minute interval between batches: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

• Canary release of one instance and phased release in two batches with manual batching: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

• Phased release in two batches, automatic batching, and a 0-minute interval between batches: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

The parameters are described as follows:

• 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 for batches. Valid values: auto and manual.

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

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

The minimum number of ready instances. Valid values:

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

• If you set this parameter to -1, the system uses a recommended value, which is 25% of the total number of instances. For example, if you have five instances, the minimum number of ready instances is 2 after the value is rounded up.

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

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

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

The memory required by each instance. Unit: MB. The value cannot be 0. This parameter corresponds to the `Cpu` parameter. The following specifications are supported:

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

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

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

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

• 12288: corresponds to 12,000 millicores.

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

• 24576: corresponds to 12,000 millicores.

• 32768: corresponds to 16,000 millicores.

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

• 131072: corresponds to 32,000 millicores.

The PHP version required for the 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 file. Make sure that the PHP server uses this configuration file to start.

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

The timeout period for a graceful shutdown. Default value: 30. Unit: seconds. The value can range from 1 to 300.

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

["a","b"]

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

The namespace ID.

The mount target of the Apsara File Storage NAS file system in the application VPC. If you do not change the NAS configuration during a deployment, you do not need to specify this parameter. If you want to clear the NAS configuration, set this parameter to an empty string ("").

The Tomcat configuration. To delete the configuration, set this parameter to "" or "{}".

• port: The port number. The port number can range from 1024 to 65535. A port number smaller than 1024 requires the root permission to be operated. Because the container is configured with the administrator permission, specify a port number that is greater than 1024. If you do not configure this parameter, the default port 8080 is used.

• contextPath: The access path. The default value is the root directory "/".

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

• uriEncoding: The URI encoding scheme of Tomcat. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If you do not set 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. The value cannot be 0. The following specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

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

• Custom configuration

  • name: The name of the environment variable.

  • value: The value of the environment variable.

• Reference a configuration item

  • 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>, for example, 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 want to reference all keys, do not specify this parameter.

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

• true: Enable AHAS.

• false: Disable AHAS.

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

• hostName: The domain name or hostname.

• ip: The IP address.

The Tomcat version that the deployment package requires. 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 the preceding example, Command="echo", 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 Real-Time Monitoring Service (ARMS) configuration file for a PHP application. Make sure that the PHP server loads the configuration file from this path.

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

The ID of the NAS file system.

The AccessKey ID that is used to read data from and write data to Object Storage Service (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 High-Speed Service Framework (HSF), such as an Ali-Tomcat container.

The time zone. Default value: Asia/Shanghai.

The application description.

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 Microservices Engine (MSE).

The ID of the Container Registry Enterprise Edition instance.

The Alibaba Cloud Resource Name (ARN) of the RAM role that is required to pull images across accounts. For more information, see Pull images across Alibaba Cloud accounts and Use a RAM role to grant permissions across Alibaba Cloud accounts.

The ID of the secret.

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

• true: Bind an EIP.

• false: Do not bind an EIP.

The configurations for collecting logs to 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.

Enables service registration and discovery for a Kubernetes Service.

The configuration for service registration and discovery based on a Kubernetes Service and for end-to-end canary release.

The Nacos registry. Valid values:

• 0: SAE built-in Nacos.

• 1: User-created Nacos.

• 2: MSE Nacos.

The configurations for mounting a NAS file system.

The Python environment. PYTHON 3.9.15 is supported.

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

The name of the application after the SAE service 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 configuration of the registry. This parameter takes effect only when the registry 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 for identity authentication.

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

• internet: a public image

• intranet: a private image

The resource type. Only application is supported.

The ID of the baseline application.

The configurations of microservice governance.

• Specifies whether to enable microservice governance (enable):

  • true: Enable

  • false: Disable

• The configuration of graceful start and shutdown (mseLosslessRule):

  • delayTime: The delay time.

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

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

  • warmupTime: The warm-up duration for a small amount of 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 number of GPUs.

The GPU card type.

Specifies whether to enable custom metric collection for Prometheus.

Specifies whether the application is a stateful application.

The Cloud Monitor service ID.

The instance name of the application in the ASI cluster.

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

The maximum number of surge instances.

The maximum surge instance ratio.

The agent version.

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

The environment tags for SLS logs.

The Loki configurations.