接口功能介绍
调用getK8sApplication接口获取容器服务K8s集群中部署的应用信息
接口约束
无
URI
GET /v1/app/inst/getK8sApplication
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appDeployId | 是 | String | 应用部署ID,数据来源于获取已部署应用列表 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appCode | String | 应用编码 | ||
appDeployCode | String | 部署编码 | ||
appDeployName | String | 应用部署名称 | ||
appDeployId | String | 应用部署ID | ||
buildPackageName | String | 构建包名称 | ||
buildPackagePath | String | 构建包路径 | ||
buildPackageType | String | 构建包类型 WAR JAR | ||
category | String | 部署类别:IMAGE_DEPLOY | ||
categoryName | String | 部署类别名称:镜像部署 | ||
changeOrderId | String | 应用变更ID | ||
clusterName | String | K8s实例名称 | ||
cpuLimit | Float | cpu下限 | 0 | |
cpuRequest | Float | cpu上限 | 0 | |
createStaff | String | 创建人 | ||
createTime | String | 创建时间 | ||
envCode | String | 环境编码 | ||
envName | String | 环境名称 | ||
memoryLimit | Integer | 内存下限 | 0 | |
memoryRequest | Integer | 内存上限 | 0 | |
namespace | String | 命名空间 | ||
projectCode | String | 项目编码 | ||
runningPod | Integer | 运行pod数 | 0 | |
statusCd | String | 实例状态 S0P 执行中 S0A 执行成功 S0E 执行失败 S0W 待执行 | ||
statusTime | String | 状态更新时间 | ||
totalPod | Integer | 总pod数 | 0 | |
appName | String | 应用名称 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":2000,
"returnObj":{
"appCode":"test1",
"appDeployCode":"test-deploy",
"appDeployName":"部署测试应用",
"appId":"975bbe99-facc-4c7c-afb5-08a315643407",
"appName":"测试应用1",
"buildPackageName":"test.jar",
"buildPackagePath":"/app/test",
"buildPackageType":"JAR",
"category":"IMAGE_DEPLOY",
"categoryName":"镜像部署",
"changeOrderId":"975bbe99-facc-4c7c-afb5-08a315643407",
"clusterName":"seed-cluster",
"cpuLimit":2,
"cpuRequest":2,
"createStaff":"张三",
"createTime":"198967000000",
"envCode":"dev-test",
"envName":"测试环境",
"memoryLimit":2,
"memoryRequest":2,
"namespace":"test-na",
"projectCode":"testproject",
"runningPod":6,
"statusCd":"S0A",
"statusTime":"169870000000",
"totalPod":8
},
"message":"成功"
}
状态码
请参考 状态码
错误码
请参考 错误码