使用InsertK8sApplication创建容器服务K8s应用。

调试

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

请求头

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

请求语法

POST /pop/v5/k8s/acs/create_k8s_app HTTPS|HTTP

请求参数

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

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

ClusterId String c9cd****

集群ID。

ImageUrl String registry.cn-beijing.aliyuncs.com/****_test/****-cons****:1.0

镜像地址。

PackageType String WAR

应用包类型。可使用FatJar、WAR、Image作为可选参数值。

IntranetTargetPort Integer 80

内网SLB后端端口,也是应用的服务端口,范围1~65535。

IntranetSlbPort Integer 80

内网SLB前端端口,范围1~65535。

ApplicationDescription String 生产环境应用

应用描述信息。

RepoId String ced********

镜像的repoId。

Replicas Integer 4

应用实例数。

LimitCpu Integer 4

应用运行过程中,应用实例的CPU限制,单位:核数。

LimitMem Integer 2

应用运行过程中,应用实例的内存限制,单位:M。

RequestsCpu Integer 0

应用创建时,应用实例的CPU限制,单位:核数。设置为0时表示不限制。

RequestsMem Integer 0

应用创建时,应用实例的内存限制,单位:M。设置为0时表示不限制。

Command String ""

设置的命令,如果设置会在镜像启动时,替代镜像中的启动命令。

CommandArgs String ""

与命令组合使用,命令的参数是JsonArray字符串,格式如:[{"argument":"-c"},{"argument":"test"}]。其中-c、test为需要设置的两个参数。

IntranetSlbProtocol String TCP

私网SLB协议,支持TCP、HTTP和HTTPS协议。

IntranetSlbId String ae93********

私网SLB ID,不配置时,EDAS会自动为用户新购SLB。

InternetSlbId String a3d4********

公网SLB ID,不配置时,EDAS会自动为用户新购SLB。

InternetSlbProtocol String TCP

公网SLB协议,支持TCP、HTTP和HTTPS协议。

InternetSlbPort Integer 80

公网SLB前端端口,范围1~65535。

InternetTargetPort Integer 8080

私网SLB后端端口,也是应用的服务端口,范围1~65535。

Envs String ""

容器的环境变量,参数为JsonArray字符串,格式如:[{"name":"testkey","value":"testValue"}]。

PreStop String ""

停止前执行脚本,格式如:{"tcpSocket":{"host":"", "port":8080}}

PostStart String ""

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

Liveness String ""

容器存活状态监测 ,格式如{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"tcpSocket":{"host":"", "port":8080}}。

Readiness String ""

容器业务状态检查,如果检查失败,经过K8s service的流量将不转入到改容器,格式如:{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}。

NasId String ""

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

MountDescs String ""

挂载配置描述,为一个序列化的JSON。例如:[{"nasPath": "/k8s","mountPath": "/mnt"},{"nasPath": "/files","mountPath": "/app/files"}]。其中,nasPath是指文件储存路径;mountPath是指挂载到容器内的路径。

StorageType String ""

目前只支持SSD型。

LocalVolume String ""

宿主机文件挂载到容器内的配置。例如:[{"type":"","nodePath":"/localfiles","mountPath":"/app/files"},{"type":"Directory","nodePath":"/mnt","mountPath":"/app/storage"}]。其中,nodePath为宿主机路径;mountPath为容器内的路径;type为挂载类型。

Namespace String default

K8s集群的命名空间,它将决定你的应用部署在哪个K8s命名空间。默认为default。

LogicalRegionId String cn-shenzhen:beta****

EDAS命名空间对应ID,非默认命名空间须填写。

PackageUrl String ""

部署包地址。通过FatJar或WAR包部署的应用需要配置部署包地址(EDAS POP API的Java或者Python SDK需要2.44.0及以上版本)。

PackageVersion String ""

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

JDK String Open JDK 8

部署的包依赖的JDK版本。可选的参数值为Open JDK 7和Open JDK 8。镜像不支持。

WebContainer String Apache Tomcat 7.0.91

部署包依赖的Tomcat版本。适用于通过WAR包部署的Spring Cloud和Dubbo应用,镜像不支持此参数。

EdasContainerVersion String EDAS-Container 3.5.5

部署的包依赖的 EDAS-Container 版本。镜像不支持。

UriEncoding String GBK

URI编码方式,支持ISO-8859-1、GBK、GB2312和UTF-8。

说明 应用配置不设置该参数,使用Tomcat默认值。
UseBodyEncoding Boolean false

useBodyEncodingForURI是否启用。

说明 应用配置不设置该参数,使用默认值false。
RequestsmCpu Integer 2

应用创建时,应用实例的CPU限制,单位:核数。

LimitmCpu Integer 0

应用运行过程中,应用实例的CPU限制。 单位:核数,设置为0表示不限制。

RuntimeClassName String runc

容器运行时类型,仅适用于使用安全沙箱容器的集群。

DeployAcrossZones String true

是否将应用实例分布到多可用区。true代表是,其他值为否。

返回数据

名称 类型 示例值 描述
ApplicationInfo Struct

应用详情。

AppId String e83acea6-****-47e1-96ae-c0e95377****

应用ID。

AppName String test

应用名称。

ChangeOrderId String ""

变更流程ID。

ClusterType Integer 5

应用集群环境类型。

  • 0-普通 Docker 集群
  • 1-Swarm 集群
  • 2-ECS 集群
  • 3-EDAS自建 K8s 集群
  • 4-Pandora 自动注册应用集群类型
  • 5-容器服务 K8s 集群
Dockerize Boolean true

是否是 Docker 应用。

EdasId String ""

用户 ID。

Owner String ""

应用创建者。

RegionId String cn-beijing

地域ID。

UserId String edas_test****@aliyun****.com

用户主账号。

Code Integer 200

code码。

Message String success

信息。

RequestId String b197-40ab-9155-****

请求ID。

示例

请求示例

POST /pop/v5/k8s/acs/create_k8s_app HTTP/1.1
公共请求头
{
  "AppName": ""
  "ClusterId": ""
  "ImageUrl": ""
  "PackageType": ""
}

正常返回示例

XML 格式

<RequestId>03FD1520-0FD6-436A-****-265318D7****</RequestId>
<HostId>edas.cn-***gzhou.****.com</HostId>
<Code>200</Code>
<Message>success</Message>

JSON 格式

{
	"RequestId": "03FD1520-0FD6-436A-****-265318D7****",
	"HostId": "edas.cn-***gzhou.****.com",
	"Code": "200",
	"Message": "success"
}

错误码

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