部署容器服务 K8S 应用。

功能

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 是否必选 示例值 描述
AppId String e83acea6-****-47e1-96ae-c0e953772cdc

应用 ID (查询 ListApplication 接口获取)

PreStop String ""

停止前执行脚本,格式如:{"tcpSocket":{"host":"", "port":8080}}。如果设置为 “” 或者 {} 代表删除,不设置代表忽略。

Envs String ""

部署环境变量,格式必须符合 JSON 对象数组

{"name":"x","value":"y"},{"name":"x2","value":"y2"}

key 固定为 name 和 value。

清空需设置为空 JSON 数组 ""

ImageTag String ""

镜像 Tag

BatchWaitTime Integer 0

PoD 更新最小间隔时间。参考 minReadySeconds

Command String ""

容器启动 Command 命令。清空需设置为空字符串 ""

PostStart String ""

启动后执行脚本,格式如:{"exec":{"command":"cat","/etc/group"}}。如果设置为 “” 或者 {} 代表删除,不设置代表忽略。

Readiness String ""

容器业务状态检查,如果检查失败,经过 k8s service 的流量将不转入到改容器,格式如:{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": {"name": "test","value": "testvalue"}}}。如果设置为 “” 或者 {} 代表删除,不设置代表忽略。

Liveness String ""

容器存活状态监测 ,格式如{"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"tcpSocket":{"host":"", "port":8080}}。如果设置为 “” 或者 {} 代表删除,不设置代表忽略。

Args String ""

容器启动 Args 命令参数,格式必须符合 JSON 数组

"参数1","参数2"

key 固定为字符串

清空需设置为空 JSON 数组 ""

Replicas Integer 1

应用实例数。最小为 0

Image String registry-vpc.cn-beijing.aliyuncs.com/t****/app:v1

镜像完整 URL,覆盖 ImageTag 参数

CpuLimit Integer 1

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

MemoryLimit Integer 0

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

CpuRequest Integer 0

应用运行过程中,应用实例的 CPU 申请需要的配额, 单位:核数。0 为不要求

MemoryRequest Integer 0

应用运行过程中,应用实例的 内存 申请需要的配额,单位:M。0 为不要求

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 型,Performance。

LocalVolume String ""

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

PackageUrl String ""

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

  • 版本)。
PackageVersion String ""

部署包的版本号,WAR 和 FatJar 类型必填。请自定义它的含义(EDAS POP API 的 Java 或者 Python SDK 需要 2.44.0

  • 版本)。
JDK String ""

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

WebContainer String ""

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

EdasContainerVersion String ""

部署包依赖的 EDAS Container 版本。适用于通过 WAR 包部署的 HSF 应用,镜像不支持此参数。

UriEncoding String ""

URI 编码方式,支持 ISO-8859-1、GBK、GBK213、UTF-8;

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

UseBodyEncoding Boolean false

useBodyEncodingForURI 是否启用;

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

UpdateStrategy String ”“

更新策略

MCpuRequest Integer 0

应用运行过程中,应用实例的 CPU 申请需要的配额, 单位:微核数。0 为不要求。

MCpuLimit Integer 0

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

返回数据

名称 类型 示例值 描述
RequestId String a5281053-08e4-47a5-b2ab-5c0323de7b5a

请求唯一标示 ID

Code Integer 200

code 码

Message String success

信息

ChangeOrderId String cd65b247-****-475b-ad4b-7039040d625c

调用 GetChangeOrderInfo 接口获取这次部署具体执行进展

示例

请求示例

POST /pop/v5/k8s/acs/k8s_apps HTTP/1.1
公共请求头
{
  "AppId": "e83acea6-****-47e1-96ae-c0e953772cdc"
}

正常返回示例

JSON 格式

{
	"Message": "success",
	"ChangeOrderId": "cd65b247-cbe8-475b-ad4b-7039040d625c",
	"Code": 200
}

XML 格式

<Message>success</Message>
<ChangeOrderId>cd65b247-cbe8-475b-ad4b-7039040d625c</ChangeOrderId>
<Code>200</Code>

错误码

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