创建一个SAE应用

调试

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

请求头

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

请求语法

POST /pop/v1/sam/app/createApplication HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
AppName String test-app

应用名称。允许数字,字母以及中划线组合。必须字母打头,最大长度36个字符。

NamespaceId String cn-beijing:test

EDAS命名空间对应ID。仅支持名称为小写字母加中划线的命名空间,必须以字母开头。

命名空间可从DescribeNamespaceList接口获取。

PackageType String FatJar

应用包类型。支持FatJar、War、Image。

Replicas Integer 1

初始实例数。

AppDescription String This is a test description.

应用描述信息。不超过1024个字符。

VpcId String vpc-xxxxxxxxxxxxxxxxxxx

EDAS命名空间对应的VPC。在Serverless中,一个命名空间只能对应一个VPC,且不能修改。第一次在命名空间内创建Serverless应用将形成绑定关系。多个命名空间可以对应一个VPC。不填则为命名空间绑定的VpcId。

VSwitchId String vsw-xxxxxxxxxxxxxxxxxxx

应用实例弹性网卡所在的虚拟交换机。该交换机必须位于上述VPC内。该交换机与EDAS命名空间同样存在绑定关系。不填则为命名空间绑定的VSwitchId。

PackageVersion String 1.0.0

部署的包的版本号,War FatJar类型必填。请自定义它的含义。

PackageUrl String http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/sae-test.jar

部署包地址。只有FatJar或War类型应用可以配置部署包地址。

ImageUrl String registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1

镜像地址。只有Image类型应用可以配置镜像地址。

Jdk String Open JDK 8

部署的包依赖的JDK版本。镜像不支持。

WebContainer String apache-tomcat-7.0.91

部署的包依赖的tomcat版本。镜像不支持。

Cpu Integer 1000

每个实例所需的CPU,单位为毫核,不能为0。目前仅支持固定规格的实例类型。

Memory Integer 1024

每个实例所需的内存,单位为MB,不能为0。目前仅支持固定规格的实例类型。

Command String sleep

镜像启动命令。该命令必须为容器内存在的可执行的对象。例如:sleep。设置该命令将导致镜像原本的启动命令失效。

CommandArgs String 1d

镜像启动命令参数。上述启动命令所需参数。例如: ["1d"]

Envs String [{"name":"envtmp","value":"0"}]

容器环境变量参数。例如: [{"name":"envtmp","value":"0"}]

CustomHostAlias String [{"hostName":"samplehost","ip":"127.0.0.1"}]

容器内自定义host映射。例如: [{"hostName":"samplehost","ip":"127.0.0.1"}]

JarStartOptions String custom-option

Jar包启动应用选项。应用默认启动命令:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

JarStartArgs String custom-args

Jar包启动应用参数。应用默认启动命令:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

Liveness String {"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}

容器健康检查,健康检查失败的容器将被杀死并恢复。目前仅支持容器内下发命令的方式。列如:{"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}

Readiness String {"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}

应用启动状态检查,多次健康检查失败的容器将被杀死并重启。不通过健康检查的容器将不会有SLB流量进入。例如: {"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}

Deploy Boolean true

是否立即部署生效,默认为否。

EdasContainerVersion String 3.5.3

EDAS pandora应用使用的运行环境。

Timezone String Asia/Shanghai

应用时区默认Asia/Shanghai。

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

文件日志采集配置

NasId String KSAK12D5

挂载的NAS的ID,必须与集群处在同一个region。它必须有可用的挂载点创建额度,或者其挂载点已经在VPC内的交换机上。如果不填,且存在mountDescs字段,则默认将自动购买一个NAS并挂载至VPC内的交换机上。

MountHost String xxxx.com

nas在应用vpc内的挂载点。

MountDesc String [{MountPath: "/tmp", NasPath: "/"}]

挂载描述

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

停止前执行脚本,格式如:{"exec":{"command":"cat","/etc/group"}}

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

启动后执行脚本,格式如:{"exec":{"command":"cat","/etc/group"}}

WarStartOptions String custom-option

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

返回数据

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

接口状态或 POP 错误码

Data Struct

返回结果

AppId String 017f39b8-dfa4-4e16-a84b-1dcee4b17106

创建成功的应用ID。

ChangeOrderId String 01db03d3-3ee9-48b3-b3d0-dfce2d88ab31

返回的发布单ID,用于查询任务执行状态。

ErrorCode String success

错误码

Message String success

附加信息

RequestId String 00000000-0000-0000-0000-000000000000

请求ID

Success Boolean true

是否成功

TraceId String 00000000-0000-0000-0000-000000000000

调用链ID

示例

请求示例

POST /pop/v1/sam/app/createApplication HTTP/1.1
公共请求头
{
  "AppName": "test-app"
  "NamespaceId": "cn-beijing:test"
  "PackageType": "FatJar"
  "Replicas": "1"
}

正常返回示例

XML 格式

<CreateApplication>
	  <Data>
		    <ChangeOrderId>01db03d3-3ee9-48b3-b3d0-dfce2d88ab31</ChangeOrderId>
            <AppId>017f39b8-dfa4-4e16-a84b-1dcee4b17106</AppId>
      </Data>
	  <Message>success</Message>
	  <RequestId>00000000-0000-0000-0000-000000000000</RequestId>
	  <TraceId>000000000000000000000000000000</TraceId>
	  <Success>true</Success>
	  <ErrorCode>success</ErrorCode>
	  <Code>200</Code>
</CreateApplication>

JSON 格式

{
    "Data": {
        "ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88ab31",
        "AppId": "017f39b8-dfa4-4e16-a84b-1dcee4b17106"
    },
    "Message": "success",
    "RequestId": "00000000-0000-0000-0000-000000000000",
    "TraceId": "000000000000000000000000000000",
    "Success": true,
    "ErrorCode": "success",
    "Code": 200
}

错误码

HttpCode 错误码 错误信息 描述
400 Application.MissingJdk Your application must at least contain a JDK component. 应用必须至少包含JDK组件
404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist. 指定的NamespaceId不存在。
400 InvalidPackageType.NotFound The package type must be War, FatJar, or Image. 包类型必须为War、Fatjar或Image
400 InvalidParameter.FileName The application deployment package name is invalid. This name can contain only alphanumeric characters, hyphens (-), and underscores (_). In addition, you can upload JAR files only if the selected deployment version supports JAR file. Otherwise, upload WAR files only. 应用部署程序包名称无效。名称只能包含字母、数字和特殊字符“-”“_”。另外,仅当选择的部署版本支持JAR部署时方可上传JAR包,否则只能上传WAR包。
400 InvalidParameter.NotEmpty You must specify the parameter %s. 不合法的参数:%s 不能为空
400 InvalidParameter.Obviously The specified parameter is invalid {%s}. 不合法的参数{%s}
400 JarApplication.MissingJdk A FatJar application must contain JDK. FatJAR类型应用必须包含JDK
400 NoAvailableCluster.NotFound No clusters are available for the current region. 当前地域没有可用集群
400 NoComputeResourceQuota.Exceed Your compute resource is insufficient. Please submit a ticket to raise the quota. 计算资源不足,请提交工单增加计算资源额度。
400 PandoraApplication.MissingJdk The Pandora application is missing a JDK component. pandora应用缺少JDK组件
400 PandoraApplication.OnlyJdk A Pandora application only requires JDK component. pandora应用只需要JDK组件
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s 不合法的参数{%s}:%s
400 InvalidComponent.NotFound The current component (such as JDK, Tomcat, or EDASWebContainer) does not exist. 找不到当前组件(JDK、Tomcat、EDASWebContainer等)
400 InvalidHostnameIp.Invalid The hostname and/or IP is invalid: Hostname [%s], IP [%s]. 主机名和/或IP不合法:主机名[%s],IP[%s]。
400 InvalidInstanceSpecification.Unsupported The instance specification is not supported: CPU [%s], memory [%s]. 不支持的实例规格。CPU[%s],Memory[%s]。
400 InvalidServerlessRegion.Unsupported The current region is not supported: %s 不支持当前地域:%s
404 InvalidVpcId.NotFound The specified VpcId does not exist. 指定的VpcId不存在。
400 WarApplication.MissingJdkWebcontainer A War application must contain JDK and Tomcat. War类型应用必须包含JDK和Tomcat
400 InvalidNamespace.WithUppercase This namespace does not support creating SAE apps because it contains uppercase letters. 命名空间不支持创建SAE应用,因为它带有大写字母。
400 LogService.ConfigQuotaExceed The maximum number of Log Service configs is exceeded. 日志服务配置个数超过配额限制,请提工单解决。
400 LogService.InternalError An exception occurred while calling Log Service. Please submit a ticket to solve the problem. 调用日志服务异常,请提工单解决。
400 LogService.LogDirInvalid The log collection path is invalid. 日志采集路径不合法。
400 LogService.NotAvailable Log Service is unavailable. Please activate Log Service first. 日志服务不可用,请先开通日志服务。
400 LogService.ProjectNumQuotaExceed The maximum number of Log Service projects is exceeded. 日志服务项目个数超过配额限制,请提工单解决。
400 vswitch.not.exist The specified VSwitch does not exist. VSwitch不存在,请更换VSwitch
400 user.indebt The user has an outstanding payment. 当前用户处于欠费状态
400 NoComputeResourceQuota.App.Exceed You can create %s instances for each application. Please submit a ticket to raise the quota. 每个应用只允许创建%s个实例,请提交工单增加计算资源额度。
400 NoComputeResourceQuota.User.Exceed Your account is limited to create %s instances. Please submit a ticket to raise the quota. 您的账户限额%s个实例,请提交工单增加计算资源额度。
400 System.Upgrading The system is being upgraded. Please try again later. 系统正在升级,请稍后操作
400 VolumnPath.Conflict Conflict between log collection directory and persistent storage directory. 日志采集目录与持久化存储目录冲突。

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