变更更新
功能介绍
更新变更单信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/changes/{change_id}
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
change_id |
String |
是 |
参数解释: 变更单号。 约束限制: 字符串 取值范围: 字符长度1-50 默认取值: 不涉及 |
请求参数
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
ticket_info |
TicketInfoObject |
否 |
参数解释: 变更主单信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sub_tickets |
Arrays of SubTicketInfoObject |
否 |
参数解释: 变更子单信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
history_info |
TicketHistoryInfoObject |
否 |
参数解释: 变更历史信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
phase |
String |
否 |
参数解释: 工单操作的类型,枚举值。 约束限制: 字符串,长度限制0-255 取值范围: 枚举值
默认取值: 不涉及 |
work_flow_status |
String |
否 |
参数解释: 工单状态。 约束限制: 字符串,长度限制0-255 取值范围: 不涉及 默认取值: 不涉及 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
ticket_id |
String |
否 |
参数解释: 子单ID。 约束限制: 字符串,长度限制0-100 取值范围: 不涉及 默认取值: 不涉及 |
change_result |
String |
否 |
参数解释: 变更结果。 约束限制: 字符串,长度限制1-100 取值范围: 不涉及 默认取值: 不涉及 |
is_verified_in_change_time |
Boolean |
否 |
参数解释: 在时间窗内是否可验证。 约束限制: 不涉及 取值范围: true/false 默认取值: 不涉及 |
verified_docs |
String |
否 |
参数解释: 验证文档ID。 约束限制: 字符串,长度限制0-1000 取值范围: 不涉及 默认取值: 不涉及 |
comment |
String |
否 |
参数解释: 变更失败原因描述。 约束限制: 字符串,长度限制0-100 取值范围: 不涉及 默认取值: 不涉及 |
change_fail_type |
String |
否 |
参数解释: 变更失败类型。 约束限制: 字符串,长度限制1-100 取值范围: 不涉及 默认取值: 不涉及 |
rollback_start_time |
Long |
否 |
参数解释: 回退开始时间。 约束限制: 不涉及 取值范围: 1-9999999999999 默认取值: 不涉及 |
rollback_end_time |
Long |
否 |
参数解释: 回退结束时间。 约束限制: 不涉及 取值范围: 1-9999999999999 默认取值: 不涉及 |
is_rollback_success |
Boolean |
否 |
参数解释: 是否回退成功。 约束限制: 不涉及 取值范围: true/false 默认取值: 不涉及 |
is_monitor_found |
Boolean |
否 |
参数解释: 是否被监控发现。 约束限制: 不涉及 取值范围: true/false 默认取值: 不涉及 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
action |
String |
否 |
参数解释: 操作类型。 约束限制: 字符串,长度限制1-1000 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
provider_code |
String |
否 |
参数解释: 服务标识。 取值范围: 字符长度0-256 默认取值: 049 |
error_code |
String |
否 |
参数解释: 请求响应代码,范围:0000~9999,正常时取值:0。 取值范围: 字符长度0-256 默认取值: 0 |
error_msg |
String |
否 |
参数解释: 请求响应描述。 取值范围: 字符长度0-256 默认取值: 不涉及 |
请求示例
- 变更结束。
PUT https://{Endpoint}/v2/changes/{change_id} { "history_info": { "action": "change_end_change_success" }, "sub_tickets": [ { "ticket_id": " 92f0c22f-4ca4-4cbe-89cf-281aed331f50" } ] }
- 添加变更结果:在变更计划执行变更结束后执行。
PUT https://{Endpoint}/v2/changes/{change_id} { "sub_tickets": [ { "ticket_id": "{{sub_ticket_id}}", "sub_tickets": [ ], "change_result": "change_result_failed", "verified_docs1": "e67a0d67-310e-4abd-9b35-43eacf681358", "verified_docs": null, "comment": "111", "change_fail_type": "fr_dependent_service_issue", "rollback_start_time": 1742888808000, "rollback_end_time": 1742975208000, "is_rollback_success": false, "is_monitor_found": true } ], "history_info": { "action": "change_set_change_result_success" } }
- 关单:在所有变更计划执行完成后执行。
PUT https://{Endpoint}/v2/changes/{change_id} { "history_info": { "action": "change_complete_success" }, "ticket_info": { "phase": "phase_change_end", "work_flow_status": "COMPLETE" } }
响应示例
状态码:200
请求成功。
更多状态码请参考状态码。
{ "provider_code": "049", "error_code": "GOM.00000000", "error_msg": null }
状态码:400
服务器未能处理请求。
更多状态码请参考状态码。
{ "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : "049", "data" : null }
错误码
请参见错误码。