新建工单
功能介绍
创建变更单或问题单的接口,通过路径参数ticket_type区分需要创建的工单类型。ticket_type为change表示要创建变更单,ticket_type为issues_mgmt为创建问题单。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{ticket_type}/tickets
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ticket_type |
是 |
String |
参数解释: 需要创建的工单类型,如需创建变更单传值change,如需创建问题单传值issues_mgmt。 约束限制: 不涉及 取值范围: 枚举值:
默认取值: incident |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
title |
否 |
String |
参数解释: 工单标题。 约束限制: 字符串,长度限制1-255 取值范围: 不涉及 默认取值: 不涉及 |
change_notes |
否 |
String |
参数解释: 变更单描述。 约束限制: 当ticket_type为change创建变更单时,该字段必填。长度限制1-4096 取值范围: 不涉及 默认取值: 不涉及 |
description |
否 |
String |
参数解释: 问题单描述信息。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段必填。 取值范围: 不涉及 默认取值: 不涉及 |
enterprise_project |
否 |
String |
参数解释: 企业项目ID,当企业项目传递default时,此值为0,该信息通过EPS云服务进行查询企业项目列表获取。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段必填。 取值范围: 不涉及 默认取值: 0 |
change_type |
否 |
String |
参数解释: 变更类型,其中change_type_conventional表示常规变更,change_type_urgentu表示紧急变更。 约束限制: 当ticket_type为change创建变更单时,该字段必填。 取值范围: 枚举值
默认取值: 不涉及 |
level |
否 |
String |
参数解释: 工单级别。 约束限制: 不涉及 取值范围: 当ticket_type为change创建变更单时,枚举值:
当ticket_type为issues_mgmt创建问题单时,枚举值
默认取值: 不涉及 |
ticket_type |
否 |
String |
参数解释: 问题单类型,通过访问 云运维中心-->基础配置-->流程管理页签下问题流程-->问题单类别可查询所有可传递的问题类型,此处传递问题类型ID。 约束限制: 当ticket_type为issues_mgmt创建问题单时,必填。 取值范围: 不涉及 默认取值: 不涉及 |
change_scheme |
否 |
String |
参数解释: 任务类型,可选作业或者变更指导书两种。 约束限制:
取值范围: 枚举值
默认取值: 不涉及 |
change_guides |
否 |
String |
参数解释: 变更指导书ID。 约束限制: 当ticket_type为change创建变更单,且任务选择变更指导书时,该字段必填。 取值范围: 不涉及 默认取值: 不涉及 |
commit_upload_attachment |
否 |
String |
参数解释: 问题单附件,上传附件ID。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
regions |
否 |
String |
参数解释: 问题单所属Region,此处传RegionID,多个Region用英文逗号隔开。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
change_scene_id |
否 |
String |
参数解释: 变更场景。 约束限制: 当ticket_type为change创建变更单时,该字段必填。 取值范围: 取配置页面【流程管理】下“变更场景”TAB页中列表属性ID列的值,示例:GOCMLL06 默认取值: 不涉及 |
current_cloud_service_id |
否 |
String |
参数解释: 变更服务ID,可通过 查询应用 接口获取。 约束限制: 当ticket_type为change创建变更单时,该字段必填。 取值范围: 不涉及 默认取值: 不涉及 |
root_cause_cloud_service |
否 |
String |
参数解释: 问题单根因服务ID,可通过 查询应用 接口获取。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
source |
否 |
String |
参数解释: 问题单来源。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 枚举值:
默认取值: 不涉及 |
source_id |
否 |
String |
参数解释: 问题单来源工单单号。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
fount_time |
否 |
Long |
参数解释: 发现时间,时间戳。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
virtual_schedule_type |
否 |
String |
参数解释: 问题单处理人类型。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段必填。 取值范围: 枚举值
默认取值: 不涉及 |
issue_contact_person |
否 |
String |
参数解释: 问题单责任人工号ID。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。如需指定问题单责任人,则该字段必填。 取值范围: 不涉及 默认取值: 不涉及 |
schedule_scenes |
否 |
String |
参数解释: 问题单责任人从排班中获取,该值为排班场景ID。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
virtual_schedule_role |
否 |
String |
参数解释: 问题单责任人从排班中获取,该值为排班角色ID。 约束限制: 当ticket_type为issues_mgmt创建问题单时,该字段选填。 取值范围: 不涉及 默认取值: 不涉及 |
location_id |
否 |
String |
参数解释: 变更区域ID。 约束限制: 当ticket_type为change创建变更单时,该字段必填。 取值范围: 不涉及 默认取值: 不涉及 |
plan_task_sub_type |
否 |
String |
参数解释: 预案子类型。 约束限制:
取值范围: 枚举值
默认取值: 不涉及 |
plan_task_id |
否 |
String |
参数解释: 需要执行的作业ID。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
plan_task_name |
否 |
String |
参数解释: 需要执行的作业名称。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
plan_task_params |
否 |
String |
参数解释: 执行作业时所需的参数信息。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
is_start_process |
否 |
Boolean |
参数解释: 是否启动流程
约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sub_tickets |
否 |
Array of TicketCreateSubTicketInfo objects |
参数解释: 变更子单的信息,包含变更单涉及的服务和Region信息。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
app_name |
否 |
String |
参数解释: 变更服务。 约束限制: 当target_type为change_scope时,该字段需传递对应的变更服务中文名称。 取值范围: 不涉及 默认取值: 不涉及 |
region |
否 |
String |
参数解释: 变更Region。 约束限制: 当target_type为change_scope时,该字段需传递对应的变更RegionID。 取值范围: 不涉及 默认取值: 不涉及 |
target_type |
否 |
String |
参数解释: 目标选项信息,该值可传递不同的信息
约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
target_value |
否 |
String |
参数解释: 传递变更单RegionID,需和target_type配合使用。 约束限制: 当target_type值为child_ticket时,该值有效。 取值范围: 不涉及 默认取值: 不涉及 |
expected_start_time |
否 |
Long |
参数解释: 变更单计划开始时间时间戳。 约束限制: 当target_type值为child_ticket时,该值有效。 取值范围: 不涉及 默认取值: 不涉及 |
expected_end_time |
否 |
Long |
参数解释: 变更单计划结束时间时间戳。 约束限制: 当target_type值为child_ticket时,该值有效。 取值范围: 不涉及 默认取值: 不涉及 |
executors |
否 |
String |
参数解释: 变更单实施人。 约束限制: 当target_type值为child_ticket时,该值有效。 取值范围: 不涉及 默认取值: 不涉及 |
cooperators |
否 |
String |
参数解释: 变更单配合人。 约束限制: 当target_type值为child_ticket时,该值有效。 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
参数解释: 服务标识。 取值范围: 不涉及 默认取值: 049 |
error_code |
String |
参数解释: 请求响应代码。 取值范围: GOM.00000000~GOM.00009999999 默认取值: GOM.00000000 |
error_msg |
String |
参数解释: 请求响应描述。 取值范围: 不涉及 默认取值: 不涉及 |
data |
data object |
返回体 |
参数 |
参数类型 |
描述 |
---|---|---|
is_start_process_async |
Boolean |
参数解释: 是否异步启动流程,该值固定值true,表示后台创建工单为异步流程。 取值范围: true 默认取值: true |
is_update_null |
Boolean |
参数解释: 是否重新提交空字段。 取值范围: false 默认取值: false |
is_return_full_info |
Boolean |
参数解释: 是否返回全部字段。 取值范围: false 默认取值: false |
is_start_process |
Boolean |
参数解释: 是否启动流程,当此值为false时,创建出来的工单为草稿状态。此值默认为true,创建出来的工单状态为未受理状态。 取值范围: 不涉及 默认取值: 不涉及 |
ticket_id |
String |
参数解释: 新创建的工单单号。 取值范围: 不涉及 默认取值: 不涉及 |
id |
String |
参数解释: 新创建的工单单号唯一ID。 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
参数解释: 服务标识。 取值范围: 不涉及 默认取值: 049 |
error_code |
String |
参数解释: 请求响应代码。 取值范围: GOM.00000000~GOM.00009999999 默认取值: GOM.00000000 |
error_msg |
String |
参数解释: 请求响应描述。 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
-
POST https://{Endpoint}//v1/change/tickets { "title" : "变更单创建", "change_notes" : "变更单描述信息,这是一个测试变更单", "change_type" : "change_type_conventional", "level" : "change_level_030", "change_scheme" : "change_scheme_guides", "change_guides" : "ad2997a2-ad31-4aed-a07b-eb22b132520a", "change_scene_id" : "GOCMLL01001", "current_cloud_service_id" : "6470681a31da2a47ed50a919", "location_id" : "xxx", "approve_type" : "or_sign", "is_start_process" : true, "sub_tickets" : [ { "target_type" : "change_scope", "app_name" : "COC应用", "region" : "cn-north-7", "resource_biz_id" : "6470681a31da2a47ed50a919" }, { "target_type" : "change_scope", "app_name" : "COC应用", "region" : "cn-north-208", "resource_biz_id" : "6470681a31da2a47ed50a919" }, { "target_type" : "child_ticket", "target_value" : "cn-north-7", "expected_start_time" : 1750755723000, "expected_end_time" : 1750842123000, "executors" : "005b950b4863447cb97cd77a89559c79", "cooperators" : "0064670859f74dc89398d676d95e3577" }, { "target_type" : "child_ticket", "target_value" : "cn-north-208", "expected_start_time" : 1750755733000, "expected_end_time" : 1750842134000, "executors" : "005b950b4863447cb97cd77a89559c79", "cooperators" : "0064670859f74dc89398d676d95e3577" } ], "plan_task_type" : "scheme_type_plan_task", "plan_task_sub_type" : "", "plan_task_id" : "", "plan_task_name" : "", "plan_task_params" : "" }
-
POST https://{Endpoint}/v1/issues_mgmt/tickets { "title" : "sdk_test_create", "description" : "【问题现象】sdk创建问题单\n【问题对现网的影响】", "commit_upload_attachment" : "", "regions" : "", "enterprise_project" : "0", "level" : "issues_level_4000", "ticket_type" : "issues_type_1000", "root_cause_cloud_service" : "6470681a31da2a47ed50a919", "source" : null, "source_id" : "", "fount_time" : 0, "virtual_schedule_type" : "issues_mgmt_virtual_schedule_type_2000", "issue_contact_person" : "51875a8200fd45189f94745678545bc3", "schedule_scenes" : "", "virtual_schedule_role" : "" }
响应示例
状态码:200
请求成功。
{
"error_code" : "GOM.00000000",
"error_msg" : null,
"provider_code" : "049",
"data" : {
"is_start_process_async" : true,
"is_update_null" : false,
"is_return_full_info" : false,
"is_start_process" : true,
"ticket_id" : "CM202506241152560174680890",
"id" : "f9990e23-188f-4979-b5e8-57d265cfc90d"
}
}
状态码:400
服务器未能处理请求。
更多状态码请参考状态码。
{
"error_code" : "GOM.00007256",
"error_msg" : "参数错误",
"provider_code" : "049",
"data" : null
}
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
服务器未能处理请求。 更多状态码请参考状态码。 |
错误码
请参见错误码。