调用DescribeApplicationConfig接口获取应用配置信息。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /pop/v1/sam/app/describeApplicationConfig HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
AppId String 7171a6ca-d1cd-4928-8642-7d5cfe69****

应用ID

VersionId String 0026ff7f-2b57-4127-bdd0-9bf202bb****

版本ID

返回数据

名称 类型 示例值 描述
Code String 200

接口状态

  • 2XX:成功
  • 3XX:重定向
  • 4XX:请求错误
  • 5XX:服务器错误
Data Struct

应用信息

AppDescription String 示例应用

应用描述信息

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

应用ID

AppName String demo-app

应用名称

BatchWaitTime Integer 10

分批发布时批次间的等待时间(单位:秒)

Command String /bin/bash

应用容器启动命令

CommandArgs String ["-c","echo 1234"]

应用容器启动命令参数

Cpu Integer 1000

应用CPU规格(单位:毫核。1核=1000毫核)

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

Hosts绑定设置

EdasContainerVersion String 3.5.3

EDAS应用环境版本

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

环境变量

ImageUrl String docker.io/library/nginx:1.14.2

镜像地址

JarStartArgs String start

JAR包部署应用的args设置

JarStartOptions String -Dtest=true

JAR包部署应用的options设置

Jdk String Open JDK 8

应用使用的JDK版本信息

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

应用实例存活检查(Liveness配置)

Memory Integer 2048

应用内存规格(单位:MB)

MinReadyInstances Integer 1

最小存活实例数

MountDesc Array

挂载描述信息

MountPath String /tmp

容器挂载路径

NasPath String /

NAS相对文件目录

MountHost String 挂载点Host

NAS在当前VSwtich上的挂载点Host

NamespaceId String cn-beijing:test

EDAS命名空间ID

NasId String AKSN89**

NAS ID

PackageType String War

应用部署类型(Image|War|Jar)

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

应用部署包地址

PackageVersion String 1.0

应用部署包版本

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

启动后执行的脚本

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

停止前执行的脚本

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

应用业务就绪检查(Readiness配置)

RegionId String cn-beijing

地域ID

Replicas Integer 2

应用实例个数

SlsConfigs String [{\"logDir\":\"/root/logs/hsf.log\"}]

文件日志采集配置

Tags Array

标签

Key String k1

标签键

Value String v1

标签值

Timezone String Asia/Shanghai

时区(默认为Asia/Shanghai)

VSwitchId String vsw-2ze559r1z1bpwqxwp****

VSwitch ID

VpcId String vpc-2ze0i263cnn311nvj****

VPC ID

WarStartOptions String custom-option

WAR包启动应用选项。应用默认启动命令:java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start

WebContainer String apache-tomcat-7.0.91

部署时设置的WebContainer

ErrorCode String success

错误码

Message String success

附加信息

RequestId String 01CF26C7-00A3-4AA6-BA76-7E95F2A3B6FF

请求ID

Success Boolean true

是否成功

TraceId String ac1a0b2215622246421415014e****

调用链ID

示例

请求示例

GET /pop/v1/sam/app/describeApplicationConfig HTTP/1.1
公共请求头
{
"AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****"
}

正常返回示例

XML 格式

<DescribeApplicationConfigResponse>
	  <Message>success</Message>
	  <RequestId>01CF26C7-00A3-4AA6-BA76-7E95F2A3B6FF</RequestId>
	  <TraceId>ac1a0b2215622246421415014e6d54</TraceId>
	  <Data>
		    <AppDescription></AppDescription>
		    <Liveness></Liveness>
		    <Memory>2048</Memory>
		    <WebContainer>apache-tomcat-7.0.91</WebContainer>
		    <Cpu>1000</Cpu>
		    <PackageVersion>222</PackageVersion>
		    <AppName>demo-app</AppName>
		    <Jdk>Open JDK 8</Jdk>
		    <JarStartArgs></JarStartArgs>
		    <MinReadyInstances>0</MinReadyInstances>
		    <Readiness></Readiness>
		    <PackageType>War</PackageType>
		    <CommandArgs></CommandArgs>
		    <VSwitchId>vsw-xxxxx</VSwitchId>
		    <Envs>[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]</Envs>
		    <JarStartOptions></JarStartOptions>
		    <Replicas>1</Replicas>
		    <CustomHostAlias>[{"hostName":"test.host.name","ip":"0.0.0.0"}]</CustomHostAlias>
		    <AppId>7171a6ca-d1cd-4928-8642-7d5cfe69a26c</AppId>
		    <VpcId>vpc-xxxx</VpcId>
		    <Command></Command>
		    <PackageUrl>https://edas-bj.oss-cn-beijing.aliyuncs.com/hello-edas.war</PackageUrl>
		    <BatchWaitTime>10</BatchWaitTime>
		    <NamespaceId>cn-beijing</NamespaceId>
		    <RegionId>cn-beijing</RegionId>
	  </Data>
	  <ErrorCode>success</ErrorCode>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeApplicationConfigResponse>

JSON 格式

{
    "DescribeApplicationConfigResponse": {
        "Message": "success",
        "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3B6FF",
        "TraceId": "ac1a0b2215622246421415014e6d54",
        "Data": {
            "AppDescription": "",
            "Liveness": "",
            "Memory": 2048,
            "WebContainer": "apache-tomcat-7.0.91",
            "Cpu": 1000,
            "PackageVersion": 222,
            "AppName": "demo-app",
            "Jdk": "Open JDK 8",
            "JarStartArgs": "",
            "MinReadyInstances": 0,
            "Readiness": "",
            "PackageType": "War",
            "CommandArgs": "",
            "VSwitchId": "vsw-xxxxx",
            "Envs": "[{&quot;name&quot;:&quot;TEST_ENV_KEY&quot;,&quot;value&quot;:&quot;TEST_ENV_VAR&quot;}]",
            "JarStartOptions": "",
            "Replicas": 1,
            "CustomHostAlias": "[{&quot;hostName&quot;:&quot;test.host.name&quot;,&quot;ip&quot;:&quot;0.0.0.0&quot;}]",
            "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69a26c",
            "VpcId": "vpc-xxxx",
            "Command": "",
            "PackageUrl": "https://edas-bj.oss-cn-beijing.aliyuncs.com/hello-edas.war",
            "BatchWaitTime": 10,
            "NamespaceId": "cn-beijing",
            "RegionId": "cn-beijing"
        },
        "ErrorCode": "success",
        "Code": 200,
        "Success": true
    }
}

错误码

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