DescribeApplicationConfig - Serverless App Engine - Alibaba Cloud Documentation Center

Queries the configurations of an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeApplicationConfig	get	All Resources ``	none	none

Request syntax

GET /pop/v1/sam/app/describeApplicationConfig HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The app id.	7171a6ca-d1cd-4928-8642-7d5cfe69****
VersionId	string	No	The version id.	0026ff7f-2b57-4127-bdd0-9bf202bb****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	01CF26C7-00A3-4AA6-BA76-7E95F2A3****
Message	string	The returned information.	success
TraceId	string	The trace ID that is used to query the details of the request.	ac1a0b2215622246421415014e****
Data	object	The information about the application.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2ze0i263cnn311nvj****
Readiness	string	The details of the health check that was performed on the container. If the container fails this health check multiple times, the system disables and restarts the container. Containers that fail health checks cannot receive traffic from Server Load Balancer (SLB) instances. You can use the exec, httpGet, or tcpSocket method to perform health checks. For more information, see the description of the Liveness parameter. Note You can use only one method to perform the health check.	{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":5}
ConfigMapMountDesc	array<object>	The details of the ConfigMap.
ConfigMapMountDesc	object
Key	string	The key-value pair that is stored in the ConfigMap.	k1
ConfigMapName	string	The name of the ConfigMap.	test
MountPath	string	The path on which the ConfigMap is mounted.	/tmp
ConfigMapId	long	The ID of the ConfigMap.	1
SecurityGroupId	string	The ID of the security group.	sg-wz969ngg2e49q5i4****
BatchWaitTime	integer	The interval between batches in a phased release. Unit: seconds.	10
Jdk	string	The version of the Java development kit (JDK) on which the deployment package of the application depends. 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 returned if the PackageType parameter is set to Image.	Open JDK 8
ImageUrl	string	The URL of the image. This parameter is returned only if the PackageType parameter is set to Image.	docker.io/library/nginx:1.14.2
SlsConfigs	string	The logging configurations of Log Service. To use Log Service resources that are automatically created by SAE, set this parameter to `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`. To use custom Log Service resources, set this parameter to `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`. The following parameters are involved: projectName: the name of the Log Service project. logDir: the path in which logs are stored. logType: the log type. stdout: the standard output log of the container. You can specify only one stdout value for this parameter. If you leave this parameter empty, file logs are collected. logstoreName: the name of the Logstore in Log Service. logtailName: the name of the Logtail configuration in Log Service. If you do not configure this parameter, 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 Log Service, leave the SlsConfigs parameter empty in the request.	[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
Liveness	string	The details of the availability check that was performed on the container. If the container fails this health check multiple times, the system disables and restarts the container. You can use one of the following methods to perform the health check: 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}` Note You can use only one method to perform the health check. 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 field is not returned, the advanced settings are not used. httpGet.keyWord: the custom keyword. 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 health checks are performed. 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 leave this parameter empty, the timeout period is automatically set to 1 second.	{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":3}
Tags	array<object>	The details of the tags.
Tag	object
Key	string	The key of the tag.	k1
Value	string	The value of the tag.	v1
PackageUrl	string	The URL of the deployment package. This parameter is returned only if the PackageType parameter is set to FatJar or War.	https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war
PackageType	string	The type of the deployment package. Valid values: If you deploy the application by using a Java Archive (JAR) package, you can set this parameter to FatJar, War, or Image. If you deploy the application by using a PHP package, you can set this parameter to 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	War
PreStop	string	The script that is run before the container is stopped. Example: `{"exec":{"command":["cat","/etc/group"]}}`	{"exec":{"command":["cat","/etc/group"]}}
PackageVersion	string	The version of the deployment package. This parameter is returned only if the PackageType parameter is set to FatJar or War.	1.0
JarStartArgs	string	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`.	start
AppName	string	The name of the application.	demo-app
AppId	string	The ID of the application.	7171a6ca-d1cd-4928-8642-7d5cfe69****
JarStartOptions	string	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`.	-Dtest=true
Replicas	integer	The number of application instances.	2
UpdateStrategy	string	The deployment 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 strategies 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 release batches. releaseType: the processing method for the batches. Valid values: auto and manual. batchWaitTime: the interval between release batches. Unit: seconds. grayUpdate: the number of release batches in the phased release after a canary release. This parameter is returned only if the type parameter is set to GrayBatchUpdate.	{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}
MinReadyInstances	integer	The minimum number of available instances. Valid values: If you set the value to 0, business interruptions occur when the application is updated. If you set the value to -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. Note Make sure that at least one instance is available during application deployment and rollback to prevent business interruptions.	1
MinReadyInstanceRatio	integer	The percentage of the minimum number of available instances. Valid values: -1: the default value. This value indicates that the minimum number of available instances is not measured by percentage. If you do not configure this parameter, the default value -1 is used. 0 to 100: indicates that 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 the percentage is set to 50% and five instances are available, the minimum number of available instances is 3. Note If the MinReadyInstance and MinReadyInstanceRatio parameters are returned and the value of the MinReadyInstanceRatio parameter is not -1, the value of the MinReadyInstanceRatio parameter takes effect. If the MinReadyInstances parameter is set to 5 and the MinReadyInstanceRatio parameter is set to 50, the value of the MinReadyInstanceRatio parameter determines the minimum number of available instances.	-1
Memory	integer	The size of memory required by each instance. Unit: MB. You cannot set this parameter 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 1000. 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 24567 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.	2048
Php	string	The version of PHP supporting PHP deployment packages. Image is not supported.	PHP-FPM 7.0
PhpConfig	string	The details of the PHP configuration file.	k1=v1
PhpConfigLocation	string	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.	/usr/local/etc/php/php.ini
PostStart	string	The script that is run immediately after the container is started. Example: `{"exec":{"command":["cat","/etc/group"]}}`	{"exec":{"command":["cat","/etc/group"]}}
TerminationGracePeriodSeconds	integer	The timeout period for a graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300.	10
CommandArgs	string	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.	["a","b"]
NamespaceId	string	The ID of the namespace.	cn-beijing:test
MountHost	string	The mount target of the NAS file system in the VPC where the application is deployed. If you do not need to modify this configuration during the deployment, configure the MountHost parameter only in the first request. You do not need to include this parameter in subsequent requests. If you need to remove this configuration, leave the MountHost parameter empty in the request.	example.com
TomcatConfig	string	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 you do not configure this parameter, the default port number 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 you do not configure this parameter, the default value ISO-8859-1 is used. useBodyEncoding: indicates whether to use the encoding scheme that is specified by BodyEncoding for URL. Default value: true.	{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
RegionId	string	The ID of the region.	cn-beijing
VSwitchId	string	The ID of the vSwitch.	vsw-2ze559r1z1bpwqxwp****
Cpu	integer	The CPU specifications that are required for each instance. Unit: millicores. You cannot set this parameter to 0. Valid values: 500 1000 2000 4000 8000 16000 32000	1000
Envs	string	The environment variables. Variable description: name: the name of the environment variable. value: the value or reference of the environment variable.	[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
MountDesc	array<object>	The details of the mounted NAS file system.
MountDesc	object
MountPath	string	The path on which the NAS file system is mounted.	/tmp
NasPath	string	The directory in the NAS file system.	/
EnableAhas	string	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.	true
CustomHostAlias	string	The custom mappings between hostnames and IP addresses in the container. Valid values: hostName: the domain name or hostname. ip: the IP address.	[{"hostName":"test.host.name","ip":"0.0.0.0"}]
WebContainer	string	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.	apache-tomcat-7.0.91
Command	string	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"]`.	echo
WarStartOptions	string	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`.	custom-option
PhpArmsConfigLocation	string	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.	/usr/local/etc/php/conf.d/arms.ini
NasId	string	The ID of the NAS file system.	AKSN89**
OssAkId	string	The AccessKey ID that is used to read data from and write data to Object Storage Service (OSS) buckets.	xxxxxx
OssAkSecret	string	The AccessKey secret that is used to read data from and write data to OSS buckets.	xxxxxx
OssMountDescs	array<object>	The description of the mounted OSS bucket.
ossMountDesc	object
bucketName	string	The name of the OSS bucket.	oss-bucket
bucketPath	string	The directory or object in OSS. If the specified directory or object does not exist, an error is returned.	data/user.data
mountPath	string	The path of the container in SAE. The parameter value that you specified overwrites the original value. If the specified path does not exist, SAE automatically creates the path.	/usr/data/user.data
readOnly	boolean	Indicates whether the application can use the container path to read data from or write data to resources in the directory of the OSS bucket. Valid values: true: The application has the read-only permissions. false: The application has the read and write permissions.	true
EdasContainerVersion	string	The version of the container, such as Ali-Tomcat, in which an application developed based on High-speed Service Framework (HSF) is deployed.	3.5.3
Timezone	string	The time zone. Default value: Asia/Shanghai.	Asia/Shanghai
AppDescription	string	The description of the application.	The application description.
EnableGreyTagRoute	boolean	Indicates whether canary release rules are enabled. Canary release rules apply only to applications in Spring Cloud and Dubbo frameworks. Valid values: true: The canary release rules are enabled. false: The canary release rules are disabled.	false
MseApplicationId	string	The ID of the microservice application.	xxxxxxx@xxxxx
AcrInstanceId	string	The ID of the Container Registry Enterprise Edition instance.	cri-xxxxxx
AcrAssumeRoleArn	string	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.	acs:ram::123456789012****:role/adminrole
ImagePullSecrets	string	The ID of the corresponding secret dictionary.	10
AssociateEip	boolean	Indicates whether an elastic IP address (EIP) is associated with the application instance. Valid values: true: The EIP is associated with the application instance. false: The EIP is not associated with the application instance.	true
KafkaConfigs	string	The logging configurations of Message Queue for Apache Kafka. The following parameters are involved: KafkaConfigs: the configurations of Message Queue for Apache Kafka. createTime: the time when the Message Queue for Apache Kafka instance was created. kafkaTopic: the message topic that is used to classify messages. logDir: the path in which logs are stored. logType: the type of collected logs. Valid values: file_log: the file log that is stored in the container. The path of the file logs in the container is returned. stdout: the standard output log of the container. You can specify only one stdout value. kafkaEndpoint: the endpoint of the Message Queue for Apache Kafka service. kafkaInstanceId: the ID of the Message Queue for Apache Kafka instance. region: the region where the Message Queue for Apache Kafka instance resides.	[{"createTime":1646304855512,"kafkaTopic":"test","logDir":"/tmp/a.log","logType":"file_log"},{"createTime":1646304855512,"kafkaTopic":"test2","logDir":"/sae-stdlog/kafka-jar/","logType":"stdout"}],"kafkaEndpoint":"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX","kafkaInstanceId":"alikafka_pre-cn-7pp2l8kr****","region":"cn-beijing"}]
ProgrammingLanguage	string	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.	java
PvtzDiscovery	string	Enable K8s Service discovery and registration.	{"serviceName":"bwm-poc-sc-gateway-cn-beijing-front","namespaceId":"cn-beijing:front","portAndProtocol":{"18012":"TCP"},"enable":true}
SwimlanePvtzDiscovery	string	Configuration of K8s Service discovery and registration, and full-chain gray-release feature.	{\"enable\":\"false\",\"namespaceId\":\"cn-beijing:test\",\"portAndProtocol\":{\"2000:TCP\":\"18081\"},\"portProtocols\":[{\"port\":2000,\"protocol\":\"TCP\",\"targetPort\":18081}],\"pvtzDiscoveryName\":\"cn-beijing-1421801774382676\",\"serviceId\":\"3513\",\"serviceName\":\"demo-gray.test\"}
MicroRegistration	string	The Nacos registry. Valid values: 0: SAE built-in Nacos registry 1: self-managed Nacos registry 2 : MSE Nacos registry	"0"
NasConfigs	string	The configurations for mounting the NAS file system.	[{"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"}]
Python	string	The Python environment. PYTHON 3.9.15 is supported.	PYTHON 3.9.15
PythonModules	string	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, you can specify dependencies based on your business requirements.	Flask==2.0
MseApplicationName	string	The application name of SAE service registered in MSE.	cn-shenzhen-alb-demo-5c****
AppSource	string	The SAE application type. micro_service web job	micro_service
ServiceTags	object	The canary tag configured for the application.
	string	The canary tag	tag1
Dotnet	string	The version of .NET. .NET 3.1 .NET 5.0 .NET 6.0 .NET 7.0 .NET 8.0	.NET 8.0
MicroRegistrationConfig	string	The configuration of registration center. Takes effect only the type of registration center is MSE enterprise Nacos.	{\"instanceId\":\"mse-cn-1ls43****\",\"namespace\":\"62ee12fb-c279-4da4-be96-21********\"}
EnableIdle	boolean	Enable idle mode. true: enable false: disable	false
EnableNewArms	boolean	Enable new ARMS feature. true: enable false: disable	false
EnableCpuBurst	string	Enable CPU Burst. true: enable false: disable	true
OidcRoleName	string	The name of the RAM role used to authenticate the user identity. Note You need to create an OpenID Connect (OIDC) identity provider (IdP) and an identity provider (IdP) for role-based single sign-on (SSO) in advance. For more information, see Creates an OpenID Connect (OIDC) identity provider (IdP) and Creates an identity provider (IdP) for role-based single sign-on (SSO).	sae-test
SecretMountDesc	array<object>	Secret mount description.
SecretMountDesc	object	Secret mount description.
Key	string	The key to Base64 encode values.	task-center
SecretName	string	The name of the secret.	dummy-name-opaque-894
MountPath	string	The mount path.	/opt/www/runtime/logs
SecretId	long	The secret ID of the instance.	520
SidecarContainersConfig	array<object>	The configuration of the Sidecar container.
SidecarContainer	object	The configuration of the Sidecar container.
Name	string	The container name.	test
Cpu	integer	Set the CPU resource limit of the primary container that can be used by Sidecar container.	500
Memory	integer	Set the memory limit of the primary container that can be used by Sidecar container.	1024
ImageUrl	string	The URL of the image.	registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable
AcrInstanceId	string	The ID of Container Registry Enterprise Edition instance. This parameter is required when the ImageUrl parameter is set to the URL of an image in an ACR Enterprise Edition instance.	cri-fhzlneorxala66ip
Command	string	The command that is used to start the image. The command must be an existing executable object in the container. Sample statements: `command: - echo - abc - > - file0` In this example, the Command parameter is set to `Command="echo", CommandArgs=["abc", ">", "file0"]`.	/bin/sh
CommandArgs	string	The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the Command parameter. You can specify the name in one of the following formats: `["a","b"]` In the preceding 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. This parameter is optional.	[\"-c\",\"echo \\\"test\\\" > /home/nas/test.log && sleep 10000000s\"]
Envs	string	The environment variables. You can configure custom environment variables or reference a ConfigMap. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap . Take note of the following rules: Customize name: the name of the environment variable. value: the value of the environment variable. Reference ConfigMap name: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify `sae-sys-configmap-all-<ConfigMap name>`. Example: `sae-sys-configmap-all-test1`. valueFrom: the reference of the environment variable. Set the value to `configMapRef`. configMapId: the ConfigMap ID. key: the key. If you want to reference all keys, do not configure this parameter.	[{\"name\":\"k1\",\"value\":\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\"}]
ConfigMapMountDesc	array<object>	The description of the ConfigMap instance mounted to the application. Use configurations created on the Configuration Items page to configure containers. The following table describes the parameters that are used in the preceding statements. congfigMapId: the ID of the ConfigMap instance. You can call the ListNamespacedConfigMaps operation to obtain the ID. key: the key. Note You can use the `sae-sys-configmap-all` key to mount all keys. mountPath: the mount path in the container.
ConfigMapMountDesc	object	The description of the ConfigMap instance mounted to the application.
Key	string	The ConfigMap key	key
ConfigMapName	string	The ConfigMap name.	ConfigMap-test
MountPath	string	The mount path.	/mnt/test
ConfigMapId	long	The ConfigMap ID.	7361
EmptyDirDesc	array<object>	Shared temporary storage mounted to the primary container and the Sidecar container.
EmptyDirDesc	object	Shared temporary storage.
Name	string	The name of the shared temporary storage.	sidecar-container
MountPath	string	Mount path of the data volume within the container.	/mnt/cache
InitContainersConfig	array<object>	Initialize container configuration.
InitContainer	object	Initialize container configuration.
Name	string	The name of the initialized container.	init-container
ImageUrl	string	The image URL of the initialized container.	registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
Command	string	The command that is used to start the image. The command must be an existing executable object in the container. Sample statements: `command: - echo - abc - > - file0` In this example, the Command parameter is set to `Command="echo", CommandArgs=["abc", ">", "file0"]`.	/bin/sh
CommandArgs	string	The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the Command parameter. You can specify the name in one of the following formats: `["a","b"]` In the preceding 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. This parameter is optional.	["a","b"]
Envs	string	The environment variables. You can configure custom environment variables or reference a ConfigMap. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap . Take note of the following rules: Customize name: the name of the environment variable. value: the value of the environment variable. Reference ConfigMap name: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify `sae-sys-configmap-all-<ConfigMap name>`. Example: `sae-sys-configmap-all-test1`. valueFrom: the reference of the environment variable. Set the value to `configMapRef`. configMapId: the ConfigMap ID. key: the key. If you want to reference all keys, do not configure this parameter.	[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
ConfigMapMountDesc	array<object>	The information of ConfigMap.
ConfigMapMountDesc	object	The key-value pair of ConfigMap.
Key	string	The key.	k1
ConfigMapName	string	The name of the ConfigMap.	test
MountPath	string	The mount path.	/tmp
ConfigMapId	long	ConfigMap ID。	1
CustomImageNetworkType	string	The type of custom image. Set to empty string if using pre-built image. internet: public network image. intranet: private network image.	internet
ResourceType	string	The type of the resource. Set the value to `application`.	application
BaseAppId	string	The base app ID.	8c573618-8d72-4407-baf4-f7b64b******
MicroserviceEngineConfig	string	Configure microservices governance enable: Whether to enable microservices governance true: Enable false: Disable mseLosslessRule: Configure lossless online/offline deployment delayTime: Delay duration (unit: seconds) enable: Whether to enable lossless deployment. Set to "true" to enable; set to "false" to disable. notice: Whether to enable notifications. Set to "true" to enable; set to "false" to disable. warmupTime: Small-traffic warm-up duration (unit: seconds)	{\"Enable\":true,\"MseLosslessRule\":{\"enable\":true,\"notice\":true,\"delayTime\":10,\"warmupTime\":120,\"funcType\":2,\"aligned\":false,\"related\":false,\"lossLessDetail\":false}}
NewSaeVersion	string	The SAE application edition. lite: The lightweight edition. std: The standard edition. pro: The professional edition.	pro
ClusterId	string	The cluster ID.	495fc79c-ae61-4600-866d-a09d68******
DiskSize	integer	The disk size. Unit: GB.	20
StartupProbe	string	Enable startup probe.	{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"#!Note: If microservice config is enabled, the application will be automatically injected with the prestop configuration for lossless offline. If you delete this prestop configuration, lossless offline will not be effective.\\n echo stop > /tmp/prestop; /home/admin/.tools/curl http://127.0.0.1:54199/offline; sleep 30\"]}}
ErrorCode	string	The returned error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the configurations of an application were obtained. Valid values: true: The configurations were obtained. false: The configurations failed to be obtained.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "Data": {
    "VpcId": "vpc-2ze0i263cnn311nvj****",
    "Readiness": {
      "exec": {
        "command": [
          "curl http://localhost:8080"
        ]
      },
      "initialDelaySeconds": 20,
      "timeoutSeconds": 5
    },
    "ConfigMapMountDesc": [
      {
        "Key": "k1",
        "ConfigMapName": "test",
        "MountPath": "/tmp",
        "ConfigMapId": 1
      }
    ],
    "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
    "BatchWaitTime": 10,
    "Jdk": "Open JDK 8",
    "ImageUrl": "docker.io/library/nginx:1.14.2",
    "SlsConfigs": [
      {
        "logDir": "",
        "logType": "stdout"
      },
      {
        "logDir": "/tmp/a.log"
      }
    ],
    "Liveness": {
      "exec": {
        "command": [
          "curl http://localhost:8080"
        ]
      },
      "initialDelaySeconds": 20,
      "timeoutSeconds": 3
    },
    "Tags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ],
    "PackageUrl": "https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war",
    "PackageType": "War",
    "PreStop": {
      "exec": {
        "command": [
          "cat",
          "/etc/group"
        ]
      }
    },
    "PackageVersion": 1,
    "JarStartArgs": "start",
    "AppName": "demo-app",
    "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
    "JarStartOptions": "-Dtest=true",
    "Replicas": 2,
    "UpdateStrategy": {
      "type": "GrayBatchUpdate",
      "batchUpdate": {
        "batch": 2,
        "releaseType": "auto",
        "batchWaitTime": 1
      },
      "grayUpdate": {
        "gray": 1
      }
    },
    "MinReadyInstances": 1,
    "MinReadyInstanceRatio": -1,
    "Memory": 2048,
    "Php": "PHP-FPM 7.0",
    "PhpConfig": "k1=v1",
    "PhpConfigLocation": "/usr/local/etc/php/php.ini",
    "PostStart": {
      "exec": {
        "command": [
          "cat",
          "/etc/group"
        ]
      }
    },
    "TerminationGracePeriodSeconds": 10,
    "CommandArgs": [
      "a",
      "b"
    ],
    "NamespaceId": "cn-beijing:test",
    "MountHost": "example.com",
    "TomcatConfig": {
      "port": 8080,
      "contextPath": "/",
      "maxThreads": 400,
      "uriEncoding": "ISO-8859-1",
      "useBodyEncodingForUri": true
    },
    "RegionId": "cn-beijing",
    "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
    "Cpu": 1000,
    "Envs": [
      {
        "name": "TEST_ENV_KEY",
        "value": "TEST_ENV_VAR"
      }
    ],
    "MountDesc": [
      {
        "MountPath": "/tmp",
        "NasPath": "/"
      }
    ],
    "EnableAhas": true,
    "CustomHostAlias": [
      {
        "hostName": "test.host.name",
        "ip": "0.0.0.0"
      }
    ],
    "WebContainer": "apache-tomcat-7.0.91",
    "Command": "echo",
    "WarStartOptions": "custom-option",
    "PhpArmsConfigLocation": "/usr/local/etc/php/conf.d/arms.ini",
    "NasId": "AKSN89**",
    "OssAkId": "xxxxxx",
    "OssAkSecret": "xxxxxx",
    "OssMountDescs": [
      {
        "bucketName": "oss-bucket",
        "bucketPath": "data/user.data",
        "mountPath": "/usr/data/user.data",
        "readOnly": true
      }
    ],
    "EdasContainerVersion": "3.5.3",
    "Timezone": "Asia/Shanghai",
    "AppDescription": "The application description.",
    "EnableGreyTagRoute": false,
    "MseApplicationId": "xxxxxxx@xxxxx",
    "AcrInstanceId": "cri-xxxxxx",
    "AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
    "ImagePullSecrets": 10,
    "AssociateEip": true,
    "KafkaConfigs": "[{\"createTime\":1646304855512,\"kafkaTopic\":\"test\",\"logDir\":\"/tmp/a.log\",\"logType\":\"file_log\"},{\"createTime\":1646304855512,\"kafkaTopic\":\"test2\",\"logDir\":\"/sae-stdlog/kafka-jar*/*\",\"logType\":\"stdout\"}],\"kafkaEndpoint\":\"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX\",\"kafkaInstanceId\":\"alikafka_pre-cn-7pp2l8kr****\",\"region\":\"cn-beijing\"}]",
    "ProgrammingLanguage": "java",
    "PvtzDiscovery": {
      "serviceName": "bwm-poc-sc-gateway-cn-beijing-front",
      "namespaceId": "cn-beijing:front",
      "portAndProtocol": {
        "18012": "TCP"
      },
      "enable": true
    },
    "SwimlanePvtzDiscovery": "{\\\"enable\\\":\\\"false\\\",\\\"namespaceId\\\":\\\"cn-beijing:test\\\",\\\"portAndProtocol\\\":{\\\"2000:TCP\\\":\\\"18081\\\"},\\\"portProtocols\\\":[{\\\"port\\\":2000,\\\"protocol\\\":\\\"TCP\\\",\\\"targetPort\\\":18081}],\\\"pvtzDiscoveryName\\\":\\\"cn-beijing-1421801774382676\\\",\\\"serviceId\\\":\\\"3513\\\",\\\"serviceName\\\":\\\"demo-gray.test\\\"}",
    "MicroRegistration": 0,
    "NasConfigs": [
      {
        "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"
      }
    ],
    "Python": "PYTHON 3.9.15",
    "PythonModules": "Flask==2.0",
    "MseApplicationName": "cn-shenzhen-alb-demo-5c****",
    "AppSource": "micro_service",
    "ServiceTags": {
      "key": "tag1"
    },
    "Dotnet": ".NET 8.0",
    "MicroRegistrationConfig": "{\\\"instanceId\\\":\\\"mse-cn-1ls43******\\\",\\\"namespace\\\":\\\"62ee12fb-c279-4da4-be96-21**********\\\"}",
    "EnableIdle": false,
    "EnableNewArms": false,
    "EnableCpuBurst": true,
    "OidcRoleName": "sae-test",
    "SecretMountDesc": [
      {
        "Key": "task-center",
        "SecretName": "dummy-name-opaque-894",
        "MountPath": "/opt/www/runtime/logs",
        "SecretId": 520
      }
    ],
    "SidecarContainersConfig": [
      {
        "Name": "test",
        "Cpu": 500,
        "Memory": 1024,
        "ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable",
        "AcrInstanceId": "cri-fhzlneorxala66ip",
        "Command": "/bin/sh",
        "CommandArgs": "[\\\"-c\\\",\\\"echo \\\\\\\"test\\\\\\\" > /home/nas/test.log && sleep 10000000s\\\"]",
        "Envs": "[{\\\"name\\\":\\\"k1\\\",\\\"value\\\":\\\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\\\"}]",
        "ConfigMapMountDesc": [
          {
            "Key": "key",
            "ConfigMapName": "ConfigMap-test",
            "MountPath": "/mnt/test",
            "ConfigMapId": 7361
          }
        ],
        "EmptyDirDesc": [
          {
            "Name": "sidecar-container",
            "MountPath": "/mnt/cache"
          }
        ]
      }
    ],
    "InitContainersConfig": [
      {
        "Name": "init-container",
        "ImageUrl": "registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "Command": "/bin/sh",
        "CommandArgs": [
          "a",
          "b"
        ],
        "Envs": [
          {
            "name": "TEST_ENV_KEY",
            "value": "TEST_ENV_VAR"
          }
        ],
        "ConfigMapMountDesc": [
          {
            "Key": "k1\n",
            "ConfigMapName": "test\n",
            "MountPath": "/tmp\n",
            "ConfigMapId": 1
          }
        ]
      }
    ],
    "CustomImageNetworkType": "internet",
    "ResourceType": "application",
    "BaseAppId": "8c573618-8d72-4407-baf4-f7b64b******",
    "MicroserviceEngineConfig": "{\\\"Enable\\\":true,\\\"MseLosslessRule\\\":{\\\"enable\\\":true,\\\"notice\\\":true,\\\"delayTime\\\":10,\\\"warmupTime\\\":120,\\\"funcType\\\":2,\\\"aligned\\\":false,\\\"related\\\":false,\\\"lossLessDetail\\\":false}}",
    "NewSaeVersion": "pro",
    "ClusterId": "495fc79c-ae61-4600-866d-a09d68******",
    "DiskSize": 20,
    "StartupProbe": "{\\\"exec\\\":{\\\"command\\\":[\\\"/bin/sh\\\",\\\"-c\\\",\\\"#!Note: If microservice config is enabled, the application will be automatically injected with the prestop configuration for lossless offline. If you delete this prestop configuration, lossless offline will not be effective.\\\\n echo stop > /tmp/prestop; /home/admin/.tools/curl http://127.0.0.1:54199/offline; sleep 30\\\"]}}",
    "GpuCount": "",
    "GpuType": "",
    "EnablePrometheus": true,
    "IsStateful": true
  },
  "ErrorCode": "Null",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidApplication.NotFound	The current application does not exist.
404	InvalidAppId.NotFound	The specified AppId does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-11-27	The Error code has changed. The response structure of the API has changed	View Change Details
2025-11-04	The Error code has changed. The response structure of the API has changed	View Change Details
2025-10-24	The Error code has changed. The response structure of the API has changed	View Change Details
2025-10-13	The Error code has changed. The response structure of the API has changed	View Change Details
2025-09-29	The Error code has changed. The response structure of the API has changed	View Change Details
2025-09-18	The Error code has changed. The response structure of the API has changed	View Change Details
2025-07-30	The Error code has changed. The response structure of the API has changed	View Change Details
2025-07-29	The Error code has changed. The response structure of the API has changed	View Change Details
2025-07-04	The Error code has changed. The response structure of the API has changed	View Change Details
2025-05-29	The Error code has changed. The response structure of the API has changed	View Change Details
2025-05-26	The Error code has changed. The response structure of the API has changed	View Change Details
2025-04-25	The Error code has changed. The response structure of the API has changed	View Change Details
2025-04-07	The Error code has changed. The response structure of the API has changed	View Change Details
2025-02-26	The Error code has changed. The response structure of the API has changed	View Change Details
2025-02-13	The Error code has changed. The response structure of the API has changed	View Change Details
2025-01-20	The Error code has changed. The response structure of the API has changed	View Change Details
2025-01-13	The Error code has changed. The response structure of the API has changed	View Change Details
2025-01-02	The Error code has changed. The response structure of the API has changed	View Change Details
2024-12-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-12-17	The Error code has changed. The response structure of the API has changed	View Change Details