DescribeApplicationConfig - 获取应用配置信息_Serverless 应用引擎(SAE)-阿里云帮助中心

获取应用配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sae:DescribeApplicationConfig	get	全部资源 ``	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****
VersionId	string	否	版本 ID。	0026ff7f-2b57-4127-bdd0-9bf202bb****

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	01CF26C7-00A3-4AA6-BA76-7E95F2A3****
Message	string	调用结果的附加信息。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	ac1a0b2215622246421415014e****
Data	object	应用信息。
VpcId	string	VPC ID。	vpc-2ze0i263cnn311nvj****
Readiness	string	应用启动状态检查，多次健康检查失败的容器将被关闭并重启。不通过健康检查的容器将不会有 SLB 流量进入。支持 exec、httpGet 和 tcpSocket 方式。具体示例，请参见 Liveness 参数。说明只能选择一种方式进行健康检查。	{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":5}
ConfigMapMountDesc	array<object>	ConfigMap 信息。
ConfigMapMountDesc	object	ConfigMap 信息。
Key	string	ConfigMap 键值对。	k1
ConfigMapName	string	ConfigMap 名称。	test
MountPath	string	容器挂载路径。	/tmp
ConfigMapId	long	ConfigMap ID。	1
SecurityGroupId	string	安全组 ID。	sg-wz969ngg2e49q5i4****
BatchWaitTime	integer	分批发布时批次间的等待时间，单位为秒。	10
Jdk	string	部署包依赖的 JDK 版本。支持版本如下： Open JDK 8 Open JDK 7 Dragonwell 11 Dragonwell 8 openjdk-8u191-jdk-alpine3.9 openjdk-7u201-jdk-alpine3.9 当Package Type为 Image 时不支持。	Open JDK 8
ImageUrl	string	镜像地址。当Package Type为 Image 时必填。	docker.io/library/nginx:1.14.2
SlsConfigs	string	日志采集到 SLS 的配置。使用 SAE 自动创建的 SLS 资源：`[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`。使用自定义的 SLS 资源：`[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`。参数说明如下： projectName：配置 SLS 上的 Project 名称。 logDir：日志路径。 logType：日志类型。stdout 表示容器标准输出日志，仅可设置 1 条；如果不设置，则表示收集文件日志。 logstoreName：配置 SLS 上的 Logstore 名称。 logtailName：配置 SLS 上的 Logtail 名称，如果不指定，则表示新建 Logtail。多次部署时如果 SLS 采集配置没有变更，则不需要设置该参数（即请求中无需包含 SlsConfigs 字段）；如果不再需要使用 SLS 采集功能，您需要在请求中将该字段的值设置为空字符串（即请求中 SlsConfigs 字段的值为""）。	[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
Liveness	string	容器健康检查，健康检查失败的容器将被关闭并恢复。支持方式如下： exec：例如 `{"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}` httpGet：例如`{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}` tcpSocket：例如`{"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}` 说明只能选择一种方式进行健康检查。参数说明如下： exec.command：设置健康检查命令。 httpGet.path：访问路径。 httpGet.scheme：HTTP 或 HTTPS。 httpGet.isContainKeyWord：true 表示包含关键字，false 表示不包含关键字，缺失该字段表示不使用高级功能。 httpGet.keyWord：自定义的关键字，使用时不能缺失 isContainKeyWord 字段。 tcpSocket.port：tcp 连接检测的端口。 initialDelaySeconds：设置健康检查延迟检测时间，默认为 10，单位为秒。 periodSeconds：设置健康检查周期，默认为 30，单位为秒。 timeoutSeconds：设置健康检查超时等待时间，默认为 1，单位为秒。如果设置为 0 或不设置，默认超时等待时间为 1 秒。	{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":3}
Tags	array<object>	标签信息。
Tag	object	标签信息。
Key	string	标签键。	k1
Value	string	标签值。	v1
PackageUrl	string	部署包地址，如果您的部署包是通过 SAE 上传的需要注意以下两点：该地址不能直接下载，需要您通过 GetPackageVersionAccessableUrl 接口来获取可下载的地址（有效期 10 分钟）。该包 SAE 侧最长时间会保留 90 天，超过 90 天后不会返回给地址也不提供下载。	https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war
PackageType	string	应用包类型。取值说明如下：当您选择用 Java 部署时，支持 FatJar、War 和 Image。当您选择用 PHP 部署时，支持类型如下： 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	容器停止前执行脚本。在容器被删除前触发执行一段脚本，格式如：`{"exec":{"command":\["cat","/etc/group"\]}}`	{"exec":{"command":["cat","/etc/group"]}}
PackageVersion	string	部署包的版本号。当Package Type为 FatJar 或 War 时必填。	1.0
JarStartArgs	string	JAR 包启动应用参数。应用默认启动命令：`$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	start
AppName	string	应用名称。	demo-app
AppId	string	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****
JarStartOptions	string	JAR 包启动应用选项。应用默认启动命令：`$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	-Dtest=true
Replicas	integer	应用实例个数。	2
UpdateStrategy	string	部署策略。当最小存活实例数等于 1 时，UpdateStrategy 字段的值为""。当最小存活实例数大于 1 时，示例如下：灰度 1 台+后续分 2 批+自动分批+分批间隔 1 分钟：`{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}` 灰度 1 台+后续分 2 批+手动分批：`{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}` 分 2 批+自动分批+分批间隔 0 分钟：`{"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}` 参数说明如下： type：发布策略类型，可选灰度发布 GrayBatchUpdate 或分批发布 BatchUpdate。 batchUpdate：分批发布策略。 batch：发布批次。 releaseType：分批间处理方式，可选自动 auto 或手动 manual。 batchWaitTime：批次内部署间隔时间，单位为秒。 grayUpdate：灰度后剩余批次，当 type 为 GrayBatchUpdate 时必填。	{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}
MinReadyInstances	integer	最小存活实例数。取值说明如下：如果设置为 0，应用在升级过程中将会中断业务。如果设置为-1，最小存活实例数将使用系统推荐值，即取现有实例数的 25%。如果当前为 5 个实例，5×25%=1.25，向上取整后，最小存活实例数为 2。说明每次滚动部署最小存活的实例数建议≥1，保证业务不中断。	1
MinReadyInstanceRatio	integer	最小存活实例数百分比。取值说明如下： -1：默认值，表示不采用百分比。如果不填写，系统默认为-1。 0~100：单位为百分比，向上取整。例如设置为 50%，如果当前为 5 个实例，则最小存活实例数为 3。说明当 MinReadyInstance 和 MinReadyInstanceRatio 同时传递，且 MinReadyInstanceRatio 的取值非-1时，以 MinReadyInstanceRatio 参数为准。假设 MinReadyInstances 取值为 5，MinReadyInstanceRatio 取值为 50，则会用 MinReadyInstanceRatio 来计算最小存活实例数。	-1
Memory	integer	每个实例所需的内存，单位为 MB，不能为 0。与 CPU 为一一对应关系，目前仅支持以下固定规格： 1024：对应 CPU 为 500 毫核和 1000 毫核。 2048：对应 CPU 为 500、1000 毫核和 2000 毫核。 4096：对应 CPU 为 1000、2000 毫核和 4000 毫核。 8192：对应 CPU 为 2000、4000 毫核和 8000 毫核。 12288：对应 CPU 为 12000 毫核。 16384：对应 CPU 为 4000、8000 毫核和 16000 毫核。 24576：对应 CPU 为 12000 毫核。 32768：对应 CPU 为 16000 毫核。 65536：对应 CPU 为 8000、16000 和 32000 毫核。 131072：对应 CPU 为 32000 毫核。	2048
Php	string	PHP 部署包依赖的 PHP 版本。镜像不支持。	PHP-FPM 7.0
PhpConfig	string	PHP 配置文件内容。	k1=v1
PhpConfigLocation	string	PHP 应用启动配置挂载路径，需要您保证 PHP 服务器会使用这个配置文件启动。	/usr/local/etc/php/php.ini
PostStart	string	容器启动后执行脚本。在容器被创建后立刻触发执行一段脚本，格式如：`{"exec":{"command":\["cat","/etc/group"\]}}`	{"exec":{"command":["cat","/etc/group"]}}
TerminationGracePeriodSeconds	integer	优雅下线超时时间，默认为 30，单位为秒。取值范围为 1~300。	10
CommandArgs	string	镜像启动命令参数。启动命令 Command 所需参数。格式如下： `["a","b"]` 在 Command 参数的示例中，`CommandArgs=["abc", ">", "file0"]`，其中`["abc", ">", "file0"]`需要转成 String 类型，里面的格式为 JSON 数组。如果无此参数，则无需填写。	["a","b"]
NamespaceId	string	命名空间 ID。	cn-beijing:test
MountHost	string	NAS 在应用 VPC 内的挂载点。部署时如果配置没有变更，则不需要设置该参数（即请求中无需包含 MountHost 字段）；如果需要清除 NAS 配置，您需要在请求中将该字段的值设置为空字符串（即请求中 MountHost 字段的值为""）。	example.com
TomcatConfig	string	Tomcat 文件配置，设置为""或"{}"表示删除配置： port：端口范围为 1024~65535，小于 1024 的端口需要 Root 权限才能操作。因为容器配置的是 Admin 权限，所以请填写大于 1024 的端口。如果不配置，则默认为 8080。 contextPath：访问路径，默认为根目录"/"。 maxThreads：配置连接池的连接数大小，默认大小为 400。 uriEncoding：Tomcat 的编码格式，包括UTF-8、ISO-8859-1、GBK 和 GB2312。如果不设置，则默认为ISO-8859-1。 useBodyEncoding：是否使用BodyEncoding for URL，默认为 true。	{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
RegionId	string	地域 ID。	cn-beijing
VSwitchId	string	vSwitch ID。	vsw-2ze559r1z1bpwqxwp****
Cpu	integer	每个实例所需的 CPU，单位为毫核，不能为 0。目前仅支持以下固定规格： 500 1000 2000 4000 8000 16000 32000	1000
Envs	string	容器环境变量参数。支持自定义或引用配置项。如需引用配置项，请先创建 ConfigMap 实例。更多信息，请参见 CreateConfigMap 。取值说明如下：自定义配置 name：环境变量名称。 value：环境变量值。引用配置项 name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入`sae-sys-configmap-all-<配置项名称>`，例如`sae-sys-configmap-all-test1`。 valueFrom：环境变量引用。取值为`configMapRef`。 configMapId：配置项 ID。 key：键。如果引用全部健值，则不设置该字段。	[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
MountDesc	array<object>	挂载描述信息。
MountDesc	object	挂载描述信息。
MountPath	string	容器挂载路径。	/tmp
NasPath	string	NAS 相对文件目录。	/
EnableAhas	string	是否接入 AHAS。取值说明如下： true：接入 AHAS。 false：不接入 AHAS。	true
CustomHostAlias	string	容器内自定义 Host 映射。取值说明如下： hostName：域名或主机名。 ip：IP 地址。	[{"hostName":"test.host.name","ip":"0.0.0.0"}]
WebContainer	string	部署包依赖的 Tomcat 版本。支持版本如下： apache-tomcat-7.0.91 apache-tomcat-8.5.42 当Package Type为 Image 时不支持。	apache-tomcat-7.0.91
Command	string	镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下： `command: - echo - abc - > - file0` 根据上述示例，则`Command="echo", CommandArgs=["abc", ">", "file0"]`。	echo
WarStartOptions	string	WAR 包启动应用选项。应用默认启动命令：`java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start`。	custom-option
PhpArmsConfigLocation	string	PHP 应用监控挂载路径，需要您保证 PHP 服务器一定会加载这个路径的配置文件。您无需关注配置内容，SAE 会自动渲染正确的配置文件。	/usr/local/etc/php/conf.d/arms.ini
NasId	string	NAS ID。	AKSN****
OssAkId	string	OSS 读写的 AccessKey ID。	xxxxxx
OssAkSecret	string	OSS 读写的 AccessKey Secret。	xxxxxx
OssMountDescs	array<object>	OSS 挂载描述信息。
ossMountDesc	object	OSS 挂载描述信息。
bucketName	string	Bucket 名称。	oss-bucket
bucketPath	string	您在 OSS 创建的目录或 OSS 对象，如果 OSS 挂载目录不存在，会触发异常。	data/user.data
mountPath	string	您在 SAE 的容器路径。如果路径已存在，为覆盖关系；如果路径不存在，会新建。	/usr/data/user.data
readOnly	boolean	容器路径是否对挂载目录资源有可读权限，取值说明如下： true：只读权限。 false：读写权限。	true
EdasContainerVersion	string	HSF 框架中应用运行环境版本，例如 Ali-Tomcat 容器。	3.5.3
Timezone	string	时区，默认为Asia/Shanghai。	Asia/Shanghai
AppDescription	string	应用描述信息。	示例应用
EnableGreyTagRoute	boolean	是否启用流量灰度规则。该规则仅适用于 Spring Cloud 和 Dubbo 框架的应用。取值说明如下： true：启用灰度规则。 false：禁用灰度规则。	false
MseApplicationId	string	对应 MSE 产品侧应用 ID。	xxxxxxx@xxxxx
AcrInstanceId	string	ACR 企业版实例 ID。	cri-xxxxxx
AcrAssumeRoleArn	string	跨账号拉取镜像时所需的 RAM 角色的 ARN。更多信息，请参见跨账号拉取阿里云镜像和通过 RAM 角色实现跨云账号授权。	acs:ram::123456789012****:role/adminrole
ImagePullSecrets	string	对应保密字典 ID。	10
AssociateEip	boolean	是否绑定 EIP。取值说明如下： true：绑定。 false：不绑定。	true
KafkaConfigs	string	日志采集到 Kafka 的配置汇总信息。取值说明如下： kafkaEndpoint：Kafka API 的服务接入地址。 kafkaInstanceId：Kafka 实例 ID。 kafkaConfigs：单条或多条日志的配置汇总信息。示例值与参数说明，请参见本文的请求参数 kafkaConfigs。	{"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"}]}
ProgrammingLanguage	string	创建应用的技术栈语言。取值说明如下： java：Java 语言。 php：PHP 语言。 other：多语言，例如 Python、C++、Go、.NET 和 Node.js 等。	java
PvtzDiscovery	string	开启 K8s Service 服务注册发现。	{ "serviceName": "bwm-poc-sc-gateway-cn-beijing-front", "namespaceId": "cn-beijing:front", "portAndProtocol": { "18012": "TCP" }, "portProtocols": [ { "port": "18012", "protocol": "TCP" } ], "enable": true }
SwimlanePvtzDiscovery	string	配置基于 K8s Service 服务注册发现和全链路灰度功能。	{\"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	选择 Nacos 注册中心，取值说明如下： 0：SAE 内置 Nacos。 1：用户自建 Nacos。 2：MSE 商业版 Nacos。	"0"
NasConfigs	string	挂载 NAS 的配置。	[{"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	Python 环境。支持 PYTHON 3.9.15。	PYTHON 3.9.15
PythonModules	string	自定义安装模块依赖。默认安装根目录下 requirements.txt 定义的依赖项。如果未配置或自定义软件包，可以指定安装的依赖。	Flask==2.0
MseApplicationName	string	SAE 服务注册到 MSE 后的应用名。	cn-shenzhen-alb-demo-5c****
AppSource	string	SAE 应用类型。 micro_service。 web。 job。	micro_service
ServiceTags	object	应用配置的灰度标签
	string	灰度标签值	tag1
Dotnet	string	.NET 框架的版本号： .NET 3.1 .NET 5.0 .NET 6.0 .NET 7.0 .NET 8.0	.NET 8.0
MicroRegistrationConfig	string	注册中心配置，仅在注册中心类型为 MSE Nacos 企业版时生效。	{\"instanceId\":\"mse-cn-1ls43****\",\"namespace\":\"62ee12fb-c279-4da4-be96-21********\"}
EnableIdle	boolean	是否开启闲置模式：开启：true 关闭：false	false
EnableNewArms	boolean	是否启用新的 ARMS 功能： true：启用 false：不启用	false
EnableCpuBurst	string	是否启用 CPU Burst 功能： true：启用 false：不启用	true
OidcRoleName	string	设置身份认证服务 RAM 角色。说明需要提前创建同地域的 OIDC 身份供应商和身份供应商角色。具体信息，请参见创建 OIDC 身份供应商和创建角色 SSO 身份提供商。	sae-test
SecretMountDesc	array<object>	Secret 挂载描述。
SecretMountDesc	object	Secret 挂载描述
Key	string	对数据值进行 Base64 编码的 Key。	task-center
SecretName	string	Secret 实例名称。	dummy-name-opaque-894
MountPath	string	挂载路径。	/opt/www/runtime/logs
SecretId	long	查询的 Secret 实例 ID。	520
SidecarContainersConfig	array<object>	Sidecar 容器配置。
SidecarContainer	object	Sidecar 容器配置。
Name	string	容器名称。	test
Cpu	integer	设置 Sidecar 容器可以使用主容器的 CPU 资源上限。	500
Memory	integer	设置 Sidecar 容器可以使用主容器的内存资源上限。	1024
ImageUrl	string	镜像地址。	registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable
AcrInstanceId	string	容器镜像服务 ACR 企业版实例 ID。当 ImageUrl 为容器镜像服务企业版时必填。	cri-fhzlneorxala66ip
Command	string	镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下： `command: - echo - abc - > - file0` 根据上述示例，则`Command="echo", CommandArgs=["abc", ">", "file0"]`。	/bin/sh
CommandArgs	string	镜像启动命令参数。上述启动命令 Command 所需参数。格式如下： `["a","b"]` 在上述示例中，`CommandArgs=["abc", ">", "file0"]`，其中`["abc", ">", "file0"]`需要转成 String 类型，里面的格式为 JSON 数组。如果无此参数，则无需填写。	[\"-c\",\"echo \\\"test\\\" > /home/nas/test.log && sleep 10000000s\"]
Envs	string	容器环境变量参数。支持自定义或引用配置项。如需引用配置项，请先创建 ConfigMap 实例。更多信息，请参见 CreateConfigMap 。取值说明如下：自定义配置 name：环境变量名称。 value：环境变量值。优先级高于 valueFrom。引用配置项（valueFrom） name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入`sae-sys-configmap-all-<配置项名称>`，例如`sae-sys-configmap-all-test1`。 valueFrom：环境变量引用。取值为`configMapRef`。 configMapId：配置项 ID。 key：键。如果引用全部健值，则不设置该字段。	[{\"name\":\"k1\",\"value\":\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\"}]
ConfigMapMountDesc	array<object>	ConfigMap 挂载描述。使用在命名空间配置项页面创建的配置项来向容器中注入配置信息。参数说明如下： configMapId：ConfigMap 实例 ID。可通过调用 ListNamespacedConfigMaps 接口获取。 key：键值。说明可通过传递`sae-sys-configmap-all`参数挂载所有键。 mountPath：挂载路径。 ConfigMapName：ConfigMap 名称。
ConfigMapMountDesc	object	ConfigMap 挂载描述。
Key	string	ConfigMap 键。	key
ConfigMapName	string	ConfigMap 名称。	ConfigMap-test
MountPath	string	容器挂载路径。	/mnt/test
ConfigMapId	long	ConfigMap 实例 ID。	7361
EmptyDirDesc	array<object>	共享临时存储。设置临时存储目录，并挂载到主容器和 Sidecar 容器。
EmptyDirDesc	object	共享临时存储。
Name	string	临时存储名称。	sidecar-container
MountPath	string	数据卷在容器内的挂载路径。	/mnt/cache
InitContainersConfig	array<object>	初始化容器配置。
InitContainer	object	初始化容器配置。
Name	string	初始化容器名称。	init-container
ImageUrl	string	初始化容器使用的镜像地址。	registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
Command	string	镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下： `command: - echo - abc - > - file0` 根据上述示例，则`Command="echo", CommandArgs=["abc", ">", "file0"]`。	/bin/sh
CommandArgs	string	镜像启动命令参数。上述启动命令 Command 所需参数。格式如下： `["a","b"]` 在上述示例中，`CommandArgs=["abc", ">", "file0"]`，其中`["abc", ">", "file0"]`需要转成 String 类型，里面的格式为 JSON 数组。如果无此参数，则无需填写。	["a","b"]
Envs	string	容器环境变量参数。支持自定义或引用配置项。如需引用配置项，请先创建 ConfigMap 实例。更多信息，请参见 CreateConfigMap 。取值说明如下：自定义配置 name：环境变量名称。 value：环境变量值。优先级高于 valueFrom。引用配置项（valueFrom） name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入`sae-sys-configmap-all-<配置项名称>`，例如`sae-sys-configmap-all-test1`。 valueFrom：环境变量引用。取值为`configMapRef`。 configMapId：配置项 ID。 key：键。如果引用全部健值，则不设置该字段。引用保密字典（valueFrom） name：环境变量名称。支持引用单个或全部键，如果引用全部键，需输入`sae-sys-secret-all-<保密字典名称>`，例如`sae-sys-secret-all-test1`。 valueFrom：环境变量引用。取值为`secretRef`。 secretId：保密字典 ID。 key：键。如果引用全部健值，则不设置该字段。	[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
ConfigMapMountDesc	array<object>	ConfigMap 信息。
ConfigMapMountDesc	object	ConfigMap 键值对。
Key	string	ConfigMap 键值对。	k1
ConfigMapName	string	ConfigMap 名称。	test
MountPath	string	容器挂载路径。	/tmp
ConfigMapId	long	ConfigMap ID。	1
CustomImageNetworkType	string	自定义镜像类型，如果非自定义镜像，需要设置为空字符串： internet：公网镜像 intranet：私网镜像	internet
ResourceType	string	资源类型，仅支持`application`。	application
BaseAppId	string	基线应用 ID。	8c573618-8d72-4407-baf4-f7b64b******
MicroserviceEngineConfig	string	配置微服务治理功能。是否开启微服务治理（enable）： ture：开启 false：不开启配置无损上下线（mseLosslessRule）： delayTime：延迟事件 enable：是否启用无损上线功能，ture 为开启，false 为不开启。 notice：是否启用通知功能，ture 为启用，false 为启用。 warmupTime：小流量预热时长，单位为秒。	{\"Enable\":true,\"MseLosslessRule\":{\"enable\":true,\"notice\":true,\"delayTime\":10,\"warmupTime\":120,\"funcType\":2,\"aligned\":false,\"related\":false,\"lossLessDetail\":false}}
NewSaeVersion	string	应用版本： lite：轻量版 std：标准版 pro：专业版	pro
ClusterId	string	集群 ID。	495fc79c-ae61-4600-866d-a09d68******
DiskSize	integer	磁盘存储大小（单位 GB）。	20
StartupProbe	string	应用启动探测。	{\"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	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取应用配置信息是否成功。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "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": "AKSN****",
    "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": "示例应用",
    "EnableGreyTagRoute": false,
    "MseApplicationId": "xxxxxxx@xxxxx",
    "AcrInstanceId": "cri-xxxxxx",
    "AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
    "ImagePullSecrets": 10,
    "AssociateEip": true,
    "KafkaConfigs": {
      "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"
        }
      ]
    },
    "ProgrammingLanguage": "java",
    "PvtzDiscovery": {
      "serviceName": "bwm-poc-sc-gateway-cn-beijing-front",
      "namespaceId": "cn-beijing:front",
      "portAndProtocol": {
        "18012": "TCP"
      },
      "portProtocols": [
        {
          "port": 18012,
          "protocol": "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,
    "CmsServiceId": "",
    "HeadlessPvtzDiscovery": "",
    "Html": ""
  },
  "ErrorCode": "空",
  "Code": 200,
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidApplication.NotFound	The current application does not exist.	找不到当前应用。
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-07-29	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-07-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-05-29	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-05-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-04-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-04-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-02-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-02-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-01-20	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-01-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-01-02	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-11-08	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-10-11	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-09-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-28	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-21	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情