调用InsertK8sApplication接口在容器服务K8s集群或Serverless K8s集群中创建应用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /pop/v5/k8s/acs/create_k8s_app HTTPS|HTTP
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
AppName | String | Query | 是 | doc-test |
应用名称。必须以字母开头,支持数字、字母和短划线(-),最多支持36个字符。 |
ClusterId | String | Query | 是 | c9cd**** |
集群ID,可调用ListCluster接口获取,详情请参见ListCluster。 |
IntranetTargetPort | Integer | Query | 否 | 80 |
内网SLB后端端口,也是应用的服务端口,范围1~65535。 |
IntranetSlbPort | Integer | Query | 否 | 80 |
内网SLB前端端口,范围1~65535。 |
ImageUrl | String | Query | 否 | registry.cn-beijing.aliyuncs.com/****_test/****-cons****:1.0 |
镜像地址,当设置 |
ApplicationDescription | String | Query | 否 | 生产环境应用 |
应用描述信息 |
RepoId | String | Query | 否 | ced******** |
镜像的仓库ID |
Replicas | Integer | Query | 否 | 4 |
应用实例数 |
LimitCpu | Integer | Query | 否 | 4 |
应用运行过程中,应用实例的CPU限额,单位:核数。 |
LimitMem | Integer | Query | 否 | 2 |
应用运行过程中,应用实例的内存限额,单位:M。 |
RequestsCpu | Integer | Query | 否 | 0 |
应用创建时,应用实例的CPU限额,单位:核数。设置为0时表示不限制。 |
RequestsMem | Integer | Query | 否 | 0 |
应用创建时,应用实例的内存限额,单位:M。设置为0时表示不限制。 |
Command | String | Query | 否 | ls |
设置的命令,如果设置会在镜像启动时,替代镜像中的启动命令。 |
CommandArgs | String | Query | 否 | -lh |
与命令组合使用,命令的参数是JsonArray字符串,格式如: |
IntranetSlbProtocol | String | Query | 否 | TCP |
私网SLB协议,支持TCP、HTTP和HTTPS协议。 |
IntranetSlbId | String | Query | 否 | ae93******** |
私网SLB ID,不配置时,EDAS会自动为用户新购SLB。 |
InternetSlbId | String | Query | 否 | a3d4******** |
公网SLB ID,不配置时,EDAS会自动为用户新购SLB。 |
InternetSlbProtocol | String | Query | 否 | TCP |
公网SLB协议,支持TCP、HTTP和HTTPS协议。 |
InternetSlbPort | Integer | Query | 否 | 80 |
公网SLB前端端口,范围1~65535。 |
InternetTargetPort | Integer | Query | 否 | 8080 |
私网SLB后端端口,也是应用的服务端口,范围1~65535。 |
Envs | String | Query | 否 | \[{"name":"x","value":"y"},{"name":"x2","value":"y2"}\] |
部署环境变量,格式必须符合JSON对象数组,如: 说明 如果要取消该配置,需设置一个空JSON数组“”来表示不做配置。
|
PreStop | String | Query | 否 | {\"exec\":{\"command\":[\"ls\",\"/\"]}}" |
停止前执行脚本,示例格式: 如果设置为 |
PostStart | String | Query | 否 | {\"exec\":{\"command\":[\"ls\",\"/\"]}}" |
启动后执行脚本,格式如: 如果设置为 |
Liveness | String | Query | 否 | {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"tcpSocket":{"host":"", "port":8080}} |
容器存活状态监测 ,格式如 如果设置为 |
Readiness | String | Query | 否 | {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}} |
容器业务状态检查,如果检查失败,经过K8s Service的流量将不转入到改容器,格式如: 如果设置为 |
NasId | String | Query | 否 | dfs23**** |
挂载的NAS的ID,必须与集群在同一个地域。它必须有可用的挂载点创建额度,或者它的挂载点已经在VPC内的交换机上。如果不填,且存在mountDescs字段,则默认将自动购买一个NAS并挂载到VPC内的交换机上。 |
MountDescs | String | Query | 否 | [{"nasPath": "/k8s","mountPath": "/mnt"},{"nasPath": "/files","mountPath": "/app/files"}] |
挂载配置描述,为一个序列化的JSON。例如: |
StorageType | String | Query | 否 | Performance |
目前只支持SSD型。 |
LocalVolume | String | Query | 否 | [{"type":"","nodePath":"/localfiles","mountPath":"/app/files"},{"type":"Directory","nodePath":"/mnt","mountPath":"/app/storage"}] |
宿主机文件挂载到容器内的配置。例如:
|
Namespace | String | Query | 否 | default |
K8s集群的命名空间,它将决定你的应用部署在哪个K8s命名空间。默认为default。 |
LogicalRegionId | String | Query | 否 | cn-shenzhen:beta**** |
EDAS命名空间对应ID,非默认命名空间须填写。 |
PackageType | String | Query | 否 | WAR |
应用包类型。可选参数值包含:FatJar、WAR和Image。 |
PackageUrl | String | Query | 否 | https://e***.oss-cn-beijing.aliyuncs.com/s***-1.0-SNAPSHOT-spring-boot.jar |
部署包地址。通过FatJar或WAR包部署的应用需要配置部署包地址。 说明 EDAS POP API的Java或者Python SDK需要2.44.0或以上版本。
|
PackageVersion | String | Query | 否 | 20200720 |
部署包的版本号,WAR和FatJar类型必填。请自定义它的含义。 说明 EDAS POP API的Java或者Python SDK需要2.44.0或以上版本。
|
JDK | String | Query | 否 | Open JDK 8 |
部署的包依赖的JDK版本。可选的参数值为Open JDK 7和Open JDK 8。镜像不支持。 |
WebContainer | String | Query | 否 | apache-tomcat-7.0.91 |
部署包依赖的Tomcat版本。适用于通过WAR包部署的Spring Cloud和Dubbo应用,镜像不支持此参数。 |
EdasContainerVersion | String | Query | 否 | 3.5.9 |
部署的包依赖的 EDAS-Container 版本。 说明 使用镜像部署时不支持此参数。
|
UriEncoding | String | Query | 否 | GBK |
URI编码方式,支持ISO-8859-1、GBK、GB2312和UTF-8。 说明 应用配置不设置该参数,使用Tomcat默认值。
|
UseBodyEncoding | Boolean | Query | 否 | false |
useBodyEncodingForURI是否启用。 说明 应用配置不设置该参数,使用默认值false。
|
RequestsmCpu | Integer | Query | 否 | 2 |
应用创建时,应用实例的CPU限额,单位:核数。 |
LimitmCpu | Integer | Query | 否 | 0 |
应用运行过程中,应用实例的CPU限额。 单位:核数,设置为0表示不限制。 |
RuntimeClassName | String | Query | 否 | runc |
容器运行时类型,仅适用于使用安全沙箱容器的集群。 |
DeployAcrossZones | String | Query | 否 | true |
是否将应用实例分布到多可用区。 |
Timeout | Integer | Query | 否 | 60 |
变更流程超时时间,单位:秒。 |
EnableAhas | Boolean | Query | 否 | true |
是否接入AHAS。 |
WebContainerConfig | String | Query | 否 | {"useDefaultConfig":false,"contextInputType":"custom","contextPath":"hello","httpPort":8088,"maxThreads":400,"uriEncoding":"UTF-8","useBodyEncoding":true,"useAdvancedServerXml":false} |
Tomcat容器配置,设置为""或"{}"表示删除配置:
|
JavaStartUpConfig | String | Query | 否 | {"InitialHeapSize":{"original":512,"startup":"-Xms512m"},"MaxHeapSize":{"original":1024,"startup":"-Xmx1024m"}} |
Java启动参数用于在Java应用启动时配置启动参数。可配置:内存配置、应用、GC策略、工具、服务注册和发现配置和自定义等配置,正确配置这些参数有助于降低垃圾回收(GC)开销,从而缩短服务器响应时间并提高吞吐量。参数格式为json字符串:original为配置值,startup为启动参数,系统将自动拼接所有的startup作为应用程序的Java启动参数。设置为""或"{}"表示删除配置。 |
SlsConfigs | String | Query | 否 | [{"logstore":"thisisanotherfilelog","type":"file","logDir":"/var/log/*"},{"logstore":"","type":"stdout","logDir":"stdout.log"},{"logstore":"thisisafilelog","type":"file","logDir":"/tmp/log/*"}] |
Logstore配置,设置为""或"{}"表示删除配置:
|
IsMultilingualApp | Boolean | Query | 否 | true |
是否为多语言应用。 |
DeployAcrossNodes | String | Query | 否 | true |
是否将应用实例分布到多个节点。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ApplicationInfo | Struct |
应用详情 |
|
AppId | String | e83acea6-****-47e1-96ae-c0e95377**** |
应用ID,可通过调用ListApplication接口获取,详情请参见ListApplication。 |
AppName | String | test |
应用名称 |
ChangeOrderId | String | cd65b247-****-475b-ad4b-7039040d625c |
变更流程ID,可调用GetChangeOrderInfo接口获取,详情请参见GetChangeOrderInfo。 |
ClusterType | Integer | 5 |
应用集群环境类型。
|
Dockerize | Boolean | true |
是否为Docker应用。
|
EdasId | String | 1172****6608**** |
用户账号ID |
Owner | String | zp |
负责人 |
RegionId | String | cn-beijing |
地域ID |
UserId | String | edas_test****@aliyun****.com |
用户主账号 |
Code | Integer | 200 |
接口状态或POP错误码 |
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"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交