接口功能介绍
调用getChangeOrderInfo接口查看变更流程详情
接口约束
无
URI
GET /v1/app/inst/getChangeOrderInfo
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
changeOrderId | 是 | String | 变更流程ID,数据来源于应用历史变更单列表 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appDeployId | String | 应用部署ID | ||
batchCount | Integer | 分批次数,最少1批,最多5批 | 0 | |
batchInternal | Integer | 分批间隔,单位秒 | 0 | |
batchType | String | 分批发布时下一批变更的执行方式, AUTOMATIC-自动 MANUAL-手动 | ||
batchTypeName | String | 执行方式名称 | ||
changeOrderId | String | 应用变更ID | ||
changeSource | String | 变更来源 CONSOLE-控制台 POP-POP API或工具 | ||
changeType | String | 变更流程类型 | ||
changeTypeName | String | 变更流程类型名称 | ||
createDate | String | 创建时间 | ||
createStaff | String | 创建人 | ||
description | String | 变更描述 | ||
objectType | String | 对象类型 PIPELINE_DEPLOY、DEPLOY、OPERATE | ||
pipelineInfoList | Array of Strings | 变更流水线列表 | pipelineInfoList | |
resourceName | String | 资源名称 | ||
resourceType | String | 资源类型 INST, DEPLOYMENT, POD, SERVICE, INGRESS | ||
resourceYaml | String | 变更对应的资源yaml文件 | ||
statusCd | String | 状态 S0A 有效 S0X 无效 | ||
statusCdName | String | 状态名称 | ||
statusDate | String | 状态时间 | ||
updateDate | String | 修改时间 | ||
updateStaff | String | 修改人 | ||
msg | String | 消息内容 |
表 pipelineInfoList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pipelineInfopipelineId | String | 流水线ID | ||
pipelineInfopipelineName | String | 流水线名称 | ||
pipelineInfopipelineStatus | String | 流水线状态 | ||
pipelineInfopipelineStatusName | String | 流水线状态名称 | ||
stageList | Array of Strings | 流程列表 | stageList | |
startTime | String | 开始执行时间 | ||
updateTime | String | 更新时间 |
表 stageList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
stageName | String | 流程名称 | ||
startTime | String | 流程开始时间 | ||
status | String | 流程状态 11 等待执行 12 执行中 13 执行成功 14 执行失败 15 等待执行 | ||
statusName | String | 流水线状态名称 | ||
taskInfo | Array of Strings | 任务列表 | taskInfo | |
updateTime | String | 流程更新时间 |
表 taskInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instance | Object | 实例信息 | instance | |
resourceInfo | Object | 资源信息 | resourceInfo | |
taskId | String | 任务ID | ||
taskName | String | 任务名称 |
表 instance
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
errMsg | String | 错误信息 | ||
instanceName | String | 实例名称 | ||
instanceStatus | String | 实例状态 S0P 执行中 S0A 执行成功 S0E 执行失败 S0W 待执行 | ||
instanceStatusName | String | 实例状态名称 | ||
pods | Array of Strings | pod列表 | pods |
表 pods
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
errMsg | String | 错误信息 | ||
podIp | String | ip | ||
podName | String | 名称 | ||
podStatus | String | 状态 1 启动中 2 运行中 3 停止中 4 已停止 5 停止发生错误 6 未知错误 7 变更中 | ||
podStatusName | String | 状态名称 |
表 resourceInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
resourceName | String | 资源名称 | ||
resourceYml | String | 资源yml |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 2000,
"returnObj": {
"appDeployId": "29b25b16-0b71-48ae-8e82-3746a052b98d ",
"batchCount": 1,
"batchInternal": 60,
"batchType": " AUTOMATIC",
"batchTypeName": "自动",
"changeOrderId": "29b25b16-0b71-48ae-8e82-3746a052b98d",
"changeSource": "CONSOL",
"changeType": " DELETE",
"changeTypeName": "删除应用",
"createDate": "156865000000",
"createStaff": "张山",
"description": "部署测试应用",
"objectType": "DEPLOY",
"pipelineInfoList": [
{
"pipelineId": "29b25b16-0b71-48ae-8e82-3746a052b98d ",
"pipelineName": "发布测试应用",
"pipelineStatus": "13",
"pipelineStatusName": "执行成功",
"stageList": [
{
"stageName": "编译",
"startTime": "12365850000000",
"status": "13",
"statusName": "执行成功",
"taskInfo": [
{
"instance": {
"errMsg": " Unsupported object type ",
"instanceName": "test",
"instanceStatus": "S0A",
"instanceStatusName": "执行成功",
"pods": [
{
"errMsg": " Unsupported task for category",
"podIp": "192.168.1.1",
"podName": "pod1",
"podStatus": "2",
"podStatusName": "运行中"
}
]
},
"resourceInfo": {
"resourceName": "test1",
"resourceYml": ""
},
"taskId": "975bbe99-facc-4c7c-afb5-08a315643407",
"taskName": "部署"
}
],
"updateTime": "168980000000"
}
],
"startTime": "169898000000",
"updateTime": "169890000000"
}
],
"statusCd": "S0A",
"statusCdName": "有效",
"statusDate": "196586000000",
"updateDate": "196586000000",
"updateStaff": "张三"
},
"message": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码