StartK8sAppPrecheck_企业级分布式应用服务_API调试-阿里云OpenAPI开发者门户

请求语法

POST /pop/v5/k8s/app_precheck HTTP/1.1

请求参数

字段名称	字段详情
ClusterIdstring	集群 ID。示例值:c37aec2a-bcca-4ec1-**-**参考取值来源: InsertCluster ListCluster GetK8sCluster
Namespacestring	K8s 集群的命名空间，它将决定您的应用部署在哪个 K8s 命名空间。默认为 default。示例值:default参考取值来源: ListK8sNamespaces
AppIdstring	应用 ID。示例值:af58edcf-f7eb-**--db4e425f**
AppNamestring	应用名称。必须以字母开头，支持数字、字母和短划线（-），最多支持 36 个字符。示例值:testapp参考取值来源: InsertApplication
Replicasinteger<int32>	应用实例数。示例值:2
LimitmCpuinteger<int32>	应用运行过程中，应用实例的 CPU 限额。单位：毫核数，设置为 0 表示不限制。示例值:1000
RequestsmCpuinteger<int32>	应用创建时，应用实例的 CPU 限额，单位：毫核数。示例值:500
LimitMeminteger<int32>	应用运行过程中，应用实例的内存限额，单位：MB。LimitMem 取值要不小于 RequestsMem。示例值:4096
RequestsMeminteger<int32>	应用创建时，应用实例的内存限额，单位：MB。设置为 0 时表示不限制。RequestsMem 的取值不能大于 LimitMem 的取值。示例值:1024
LimitEphemeralStorageinteger<int32>	临时存储资源需求上限，单位：GB。设置 0 表示不限制。示例值:4
RequestsEphemeralStorageinteger<int32>	临时存储最小资源需求，单位：GB。设置 0 表示不限制。示例值:2
Envsstring	部署环境变量，格式需要符合 JSON 对象数组。支持三种类型的环境变量，分别是普通环境变量，K8s ConfigMap 环境变量，K8s Secret 环境变量。普通环境变量格式如下所示：展开详情示例值:[{"name":"x1","value":"y1"},{"name":"x2","valueFrom":{"configMapKeyRef":{"name":"my-config","key":"y2"}}},{"name":"x3","valueFrom":{"secretKeyRef":{"name":"my-secret","key":"y3"}}}]
EnvFromsstring	配置 K8s EnvFrom 类型的环境变量，将指定的 ConfigMap 或 Secret 挂载到指定目录，每个 key 对应目录下的一个文件，文件的内容为该 key 对应的 value。展开详情示例值:[ { "name": "appname", "valueFrom": { "configMapKeyRef": { "name": "appconf" } } } ]
EmptyDirsstring	配置 K8s emptyDir 挂载，支持将 emptyDir 卷挂载到指定的容器目录。EmptyDirs 的配置参数说明如下：展开详情示例值:[{"mountPath":"/app-log","subPathExpr":"$(POD_IP)"},{"readOnly":true,"mountPath":"/etc/nginx"}]
JavaStartUpConfigstring	Java 启动参数用于在 Java 应用启动时配置启动参数。可配置：内存配置、应用、GC 策略、工具、服务注册和发现配置和自定义等配置，正确配置这些参数有助于降低垃圾回收（GC）开销，从而缩短服务器响应时间并提高吞吐量。参数格式为 JSON 字符串：original 为配置值，startup 为启动参数，系统将自动拼接所有的 startup 作为应用程序的 Java 启动参数。设置为`""`或`"{}"`表示删除配置。JSON 中 key 取值如下：展开详情示例值:{"InitialHeapSize":{"original":512,"startup":"-Xms512m"},"MaxHeapSize":{"original":1024,"startup":"-Xmx1024m"}}参考取值来源: GetJavaStartUpConfig
ConfigMountDescsstring	配置 K8s ConfigMap 和 Secret 挂载，支持将 ConfigMap 和 Secret 挂载到指定的容器目录。ConfigMountDescs 的配置参数说明如下：展开详情示例值:[{"name":"nginx-config","type":"ConfigMap","mountPath":"/etc/nginx"},{"name":"tls-secret","type":"secret","mountPath":"/etc/ssh"}]
PvcMountDescsstring	配置 K8s PVC（PersistentVolumeClaim）挂载，支持将 K8s PVC 卷挂载到指定的容器目录。PvcMountDescs 的配置参数说明如下：展开详情示例值:[{"pvcName":"nas-pvc-1","mountPaths":[{"mountPath":"/usr/share/nginx/data"},{"mountPath":"/usr/share/nginx/html","readOnly":true}]}]
Annotationsstring	应用 Pod 注解。示例值:{"annotation-name-1":"annotation-value-1","annotation-name-2":"annotation-value-2"}
Labelsstring	应用 Pod 标签。示例值:{"label-name-1":"label-value-1","label-name-2":"label-value-2"}
ImageUrlstring	镜像 URL。示例值:registry.cn-hangzhou.aliyuncs.com/mw/testapp:latest
PackageUrlstring	部署包地址。示例值:https://e*.oss-cn-beijing.aliyuncs.com/s*-1.0-SNAPSHOT-spring-boot.jar
LocalVolumestring	宿主机文件挂载到容器内的配置。例如：`\[{"type":"","nodePath":"/localfiles","mountPath":"/app/files"},{"type":"Directory","nodePath":"/mnt","mountPath":"/app/storage"}\]`。其中：展开详情示例值:[{"type":"","nodePath":"/localfiles","mountPath":"/app/files"},{"type":"Directory","nodePath":"/mnt","mountPath":"/app/storage"}]
RegionIdstring	阿里云地域 ID。示例值:cn-hangzhou参考取值来源: InsertOrUpdateRegion ListEcuByRegion
ComponentIdsstring	应用组件 ID。可通过查询组件列表接口 ListComponents 接口获取。当创建的应用运行环境使用 Apache Tomcat（适用于 WAR 包部署的 Dubbo 应用）或者标准 Java 应用运行环境（适用于 JAR 包部署的 Spring Boot 或 Spring Cloud 应用）时需要指定。展开详情示例值:7参考取值来源: ListComponents

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:7638276F-**-**-884F-54CC0BC84A8D
Codeinteger<int32>	接口状态或 POP 错误码。示例值:200
Messagestring	附加信息。示例值:success
Dataobject	接口返回数据。

变更历史

	变更时间	变更内容概要	操作
	2022-11-02	新增请求参数RegionId
	2022-07-29	删除请求参数RegionId 变更请求参数AppName 变更请求参数ClusterId 变更请求参数Namespace