Serverless App Engine:DescribeApplicationConfig

VpcId

String

vpc-2ze0i263cnn311nvj****

The ID of the virtual private cloud (VPC).

Readiness

String

{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":5}

The readiness check settings of the container. If a container fails this health check multiple times, the container is stopped and then restarted. Containers that fail this health check cannot receive traffic from Server Load Balancer (SLB) instances. You can use the exec, httpGet, or tcpSocket method to perform the health check. For more information, see the Liveness parameter.

SecurityGroupId

String

sg-wz969ngg2e49q5i4****

The ID of the security group.

BatchWaitTime

Integer

10

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

Jdk

String

Open JDK 8

The version of the JDK on which the deployment package of the application 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 returned if the PackageType parameter is set to Image.

ImageUrl

String

docker.io/library/nginx:1.14.2

The URL of the image. This parameter is returned only if the PackageType parameter is set to Image.

SlsConfigs

String

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

The logging configurations of Simple Log Service.

• [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]: Simple Log Service resources automatically created by Serverless App Engine (SAE) are used.

• [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]: Custom Simple Log Service resources are used.

The following parameters are involved:

• projectName: the name of the Simple Log Service project.

• logDir: the path in which logs are stored.

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

• logstoreName: the name of the Logstore in Simple Log Service.

• logtailName: the name of the Logtail configuration in Simple Log Service. If this parameter is left empty, a new Logtail configuration is created.

If you do not need to modify the logging configurations when you deploy the application, configure the SlsConfigs parameter only in the first request. You do not need to include this parameter in subsequent requests. If you no longer need to use Simple Log Service, leave the SlsConfigs parameter empty in the request.

Liveness

String

{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":3}

The liveness check settings of the container. If a container fails this health check, the container is stopped and then restarted. Supported methods:

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

• Sample code of the httpGet method: {"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

• Sample code of the tcpSocket method: {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

The following parameters are involved:

• exec.command: the health check command.

• httpGet.path: the request path.

• httpGet.scheme: the protocol that is used to perform the health check. Valid values: HTTP and HTTPS.

• httpGet.isContainKeyWord: indicates whether the response contains keywords. Valid values: true and false. If this parameter is not returned, the advanced settings are not used.

• httpGet.keyWord: the custom keywords. This parameter is available only if the isContainKeyWord field is returned.

• tcpSocket.port: the port that is used to check the status of TCP connections.

• initialDelaySeconds: the delay of the health check. Default value: 10. Unit: seconds.

• periodSeconds: the interval at which the health check is performed. Default value: 30. Unit: seconds.

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

PackageUrl

String

https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war

The URL of the deployment package. If you use the SAE console to upload the deployment package, take note of the following items:

• You cannot download the URL. You must call the GetPackageVersionAccessableUrl operation to obtain the URL. The obtained URL is valid for 10 minutes.

• SAE can retain the package up to 90 days. After 90 days, the URL cannot be returned or downloaded.

PackageType

String

War

The type of the deployment package. Valid values:

• If you deploy a Java application, the value of this parameter can be FatJar, War, or Image.

• If you deploy a PHP application, the value of this parameter can be one of the following values:

  • 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

PreStop

String

{"exec":{"command":["cat","/etc/group"]}}

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

PackageVersion

String

1.0

The version of the deployment package. This parameter is returned only if the PackageType parameter is set to FatJar or War.

JarStartArgs

String

start

The arguments in the JAR package. The arguments are used to start the application container. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

AppName

String

demo-app

The name of the application.

AppId

String

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

The ID of the application.

JarStartOptions

String

-Dtest=true

The option settings in the JAR package. The settings are used to start the application container. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

Replicas

Integer

2

The number of application instances.

UpdateStrategy

String

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

The release policy. If the minimum number of available instances is 1, the value of the UpdateStrategy parameter is an empty string (""). If the minimum number of available instances is greater than 1, the following policies can be configured:

• The application is deployed on an instance. The remaining instances are automatically classified into two release batches whose interval is set to 1. In this case, the parameter is set to {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}.

• The application is deployed on an instance. The remaining instances are manually classified into two release batches. In this case, the parameter is set to {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}.

• All instances are automatically classified into two release batches. The application is deployed on the instances of the two batches in parallel. In this case, the parameter is set to {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}.

The following parameters are involved:

• type: the type of the release policy. Valid values: GrayBatchUpdate and BatchUpdate.

• batchUpdate: the phased release policy.

  • batch: the number of batches in which you want to release the instances.

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

  • batchWaitTime: the interval between release batches. Unit: seconds.

• grayUpdate: the number of batches in which you want to release the remaining instances after the canary release. This parameter is returned only if the type parameter is set to GrayBatchUpdate.

MinReadyInstances

Integer

1

The minimum number of available instances. Valid values:

• 0: Business interruptions occur when the application is upgraded.

• -1: The minimum number of available instances is automatically set to a system-recommended value. The value is the nearest integer to which the calculated result of the following formula is rounded up: Current number of instances × 25%. For example, if five instances are available, the minimum number of available instances is calculated by using the following formula: 5 × 25% = 1.25. In this case, the minimum number of available instances is 2.

MinReadyInstanceRatio

Integer

-1

The ratio of the minimum number of available instances to the current number of instances. Valid values:

• -1 (default value): The minimum number of available instances is not determined based on this parameter. If this parameter is not configured, the default value -1 is used.

• A number from 0 to 100: The minimum number of available instances is calculated by using the following formula: Current number of instances × (Value of MinReadyInstanceRatio × 100%). If the calculated result is not an integer, the result is rounded up to the nearest integer. For example, if five instances are available and the MinReadyInstanceRatio parameter is set to 50, the minimum number of available instances is 3.

Memory

Integer

2048

The size of memory that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter:

• This parameter is set to 1024 if the Cpu parameter is set to 500 or 1000.

• This parameter is set to 2048 if the Cpu parameter is set to 500, 1000, or 2000.

• This parameter is set to 4096 if the Cpu parameter is set to 1000, 2000, or 4000.

• This parameter is set to 8192 if the Cpu parameter is set to 2000, 4000, or 8000.

• This parameter is set to 12288 if the Cpu parameter is set to 12000.

• This parameter is set to 16384 if the Cpu parameter is set to 4000, 8000, or 16000.

• This parameter is set to 24576 if the Cpu parameter is set to 12000.

• This parameter is set to 32768 if the Cpu parameter is set to 16000.

• This parameter is set to 65536 if the Cpu parameter is set to 8000, 16000, or 32000.

• This parameter is set to 131072 if the Cpu parameter is set to 32000.

Php

String

PHP-FPM 7.0

The PHP version on which the PHP deployment package depends. This parameter is not returned if you deploy applications by using images.

PhpConfig

String

k1=v1

The details of the PHP configuration file.

PhpConfigLocation

String

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

The path on which the PHP configuration file for application startup is mounted. Make sure that the PHP server uses this configuration file during the startup.

PostStart

String

{"exec":{"command":["cat","/etc/group"]}}

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

TerminationGracePeriodSeconds

Integer

10

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

CommandArgs

String

["a","b"]

The parameters of the image startup command. The CommandArgs parameter contains the parameters that are required for the Command parameter. Format:

["a","b"].

In the preceding Command example, the CommandArgs parameter is set to CommandArgs=["abc", ">", "file0"]. The data type of ["abc", ">", "file0"] must be an array of strings in the JSON format. You do not need to configure this parameter if it does not exist in the Command parameter.

NamespaceId

String

cn-beijing:test

The ID of the namespace.

MountHost

String

example.com

The mount target of the NAS file system in the VPC in which the application is deployed. If you do not need to modify the NAS configurations when you deploy the application, configure the MountHost parameter only in the first request. You do not need to include this parameter in subsequent requests. If you no longer need to use NAS, leave the MountHost parameter empty in the request.

TomcatConfig

String

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

The Tomcat configuration. If you want to delete the configuration, set this parameter to {} or leave this parameter empty. The following parameters are involved:

• port: the port number. Valid values: 1024 to 65535. The root permissions are required to perform operations on ports whose number is smaller than 1024. Enter a value that ranges from 1025 to 65535 because the container has only the admin permissions. If this parameter is not configured, the default value 8080 is used.

• contextPath: the path. Default value: /. This value indicates the root directory.

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

• uriEncoding: the URI encoding scheme in the Tomcat container. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If this parameter is not configured, the default value ISO-8859-1 is used.

• useBodyEncoding: indicates whether the encoding scheme that is specified by BodyEncoding for URL is used. Default value: true.

RegionId

String

cn-beijing

The ID of the region.

VSwitchId

String

vsw-2ze559r1z1bpwqxwp****

The ID of the vSwitch.

Cpu

Integer

1000

The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

Envs

String

[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]

The environment variables. You can configure custom environment variables or reference a ConfigMap. Before you can reference a ConfigMap, you must create a ConfigMap. For more information, see CreateConfigMap. The following parameters are involved:

• Custom configuration

  • name: the name of the environment variable.

  • value: the value of the environment variable.

• Reference a ConfigMap

  • name: the name of the environment variable. You can reference one or all keys. To reference all keys, specify sae-sys-configmap-all-<ConfigMap name>. Example: sae-sys-configmap-all-test1.

  • valueFrom: the reference of the environment variable. Valid value: configMapRef.

  • configMapId: the ID of the ConfigMap.

  • key: the key. If you want to reference all keys, you do not need to configure this parameter.

EnableAhas

String

true

Indicates whether access to Application High Availability Service (AHAS) is enabled. Valid values:

• true: Access to AHAS is enabled.

• false: Access to AHAS is disabled.

CustomHostAlias

String

[{"hostName":"test.host.name","ip":"0.0.0.0"}]

The custom mapping between the hostname and IP address in the container. The following parameters are involved:

• hostName: the domain name or hostname.

• ip: the IP address.

WebContainer

String

apache-tomcat-7.0.91

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

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

This parameter is not returned if the PackageType parameter is set to Image.

Command

String

echo

The command that is used to start the image. The command must be an existing executable object in the container. Example:

command:
      - echo
      - abc
      - >
      - file0

In this example, the Command parameter is set to Command="echo", CommandArgs=["abc", ">", "file0"].

WarStartOptions

String

custom-option

The option settings in the WAR package. The settings are used to start the application container. The default startup command is java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start.

PhpArmsConfigLocation

String

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

The path on which the PHP configuration file for application monitoring is mounted. Make sure that the PHP server loads the configuration file.

SAE automatically generates the corresponding configuration file. No manual operations are required.

NasId

String

AKSN89**

The ID of the NAS file system.

OssAkId

String

xxxxxx

The AccessKey ID that is used to read data from and write data to Object Storage Service (OSS).

OssAkSecret

String

xxxxxx

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

EdasContainerVersion

String

3.5.3

The version of the container, such as Ali-Tomcat, in which an application that is developed based on High-speed Service Framework (HSF) is deployed.

Timezone

String

Asia/Shanghai

The time zone. Default value: Asia/Shanghai.

AppDescription

String

Sample application

The description of the application.

EnableGreyTagRoute

Boolean

false

Indicates whether the traffic canary rule is enabled. Traffic canary release rules apply only to applications in Spring Cloud and Dubbo frameworks. Valid values:

• true: The canary release rule is enabled.

• false: The canary release rule is disabled.

MseApplicationId

String

xxxxxxx@xxxxx

The ID of the microservices application.

AcrInstanceId

String

cri-xxxxxx

The ID of the Container Registry Enterprise Edition instance.

AcrAssumeRoleArn

String

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

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

ImagePullSecrets

String

10

The ID of the corresponding Secret.

AssociateEip

Boolean

true

Indicates whether an elastic IP address (EIP) is associated with the application. Valid values:

• true: The EIP is associated with the application.

• false: The EIP is not associated with the application.

KafkaConfigs

String

{"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"}]}

The logging configurations of ApsaraMQ for Kafka. The following parameters are involved:

• kafkaEndpoint: the endpoint of the ApsaraMQ for Kafka API.

• kafkaInstanceId: the ID of the ApsaraMQ for Kafka instance.

• kafkaConfigs: One or more logging configurations of ApsaraMQ for Kafka. For information about sample values and parameters, see the parameter kafkaConfigs in this topic.

ProgrammingLanguage

String

java

The programming language that is used to create the application. Valid values:

• java: Java

• php: PHP

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

PvtzDiscovery

String

{ "serviceName": "bwm-poc-sc-gateway-cn-beijing-front", "namespaceId": "cn-beijing:front", "portAndProtocol": { "18012": "TCP" }, "portProtocols": [ { "port": "18012", "protocol": "TCP" } ], "enable": true }

The configurations of Kubernetes Service-based service registration and discovery.

MicroRegistration

String

"0"

The Nacos registry. Valid values:

• 0: SAE built-in Nacos registry

• 1: Self-managed Nacos registry

• 2 : MSE Nacos registry

NasConfigs

String

[{"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"}]

The configurations for mounting the NAS file system.

Python

String

PYTHON 3.9.15

The Python environment. Valid value: PYTHON 3.9.15.

PythonModules

String

Flask==2.0

The configurations for installing custom module dependencies. By default, the dependencies defined by the requirements.txt file in the root directory are installed. If no software package is configured or customized, you can specify dependencies based on your business requirements.

MseApplicationName

String

cn-shenzhen-alb-demo-5c****

The application name that is registered in Microservices Engine (MSE).