# 新建工单 - CreateTicket #### 功能介绍 创建变更单或问题单的接口，通过路径参数ticket_type区分需要创建的工单类型。ticket_type为change表示要创建变更单，ticket_type为issues_mgmt为创建问题单。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=CreateTicket)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:ticket:create | Write | - | - | - | - | #### URI POST /v1/{ticket_type}/tickets 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ticket_type | 是 | String | **参数解释：** 需要创建的工单类型，如需创建变更单传值change，如需创建问题单传值issues_mgmt。 **约束限制：** 不涉及 **取值范围：** 枚举值： - change：变更单 - issues_mgmt：问题单 **默认取值：** 不涉及 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | title | 否 | String | **参数解释：** 工单标题。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | change_notes | 否 | String | **参数解释：** 变更单描述。 **约束限制：** 当ticket_type为change创建变更单时，该字段必填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 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创建变更单时，该字段必填。 **取值范围：** 枚举值 - change_type_conventional - change_type_urgentu **默认取值：** 不涉及 | | level | 否 | String | **参数解释：** 工单级别。 **约束限制：** 不涉及 **取值范围：** 当ticket_type为change创建变更单时，枚举值 change_level_010：A级变更 change_level_020：B级变更 change_level_030：C级变更 change_level_040：D级变更 当ticket_type为issues_mgmt创建问题单时，枚举值 issues_level_1000：致命 issues_level_2000：严重 issues_level_3000：一般 issues_level_4000：提示 **默认取值：** 不涉及 | | ticket_type | 否 | String | **参数解释：** 问题单类型，通过访问 云运维中心--\>基础配置--\>流程管理页签下问题流程--\>问题类别，可查询所有可传递的问题类型，此处传递问题类型ID。 **约束限制：** 当ticket_type为issues_mgmt创建问题单时，必填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | change_scheme | 否 | String | **参数解释：** 任务类型，可选作业或者变更指导书两种。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填 - 当取值为change_scheme_guides时，请求参数change_guides必填 - 当取值为change_scheme_runbook时，参数plan_task_sub_type、plan_task_id、plan_task_name和plan_task_params必填。 **取值范围：** 枚举值 change_scheme_runbook：作业 change_scheme_guides：变更指导书 **默认取值：** 不涉及 | | 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创建问题单时，该字段选填。 **取值范围：** 当ticket_type为issues_mgmt创建问题单时，支持选择以下枚举值： issues_mgmt_associated_type_1000：事件 issues_mgmt_associated_type_4000：运维主动发现 issues_mgmt_associated_type_2000：告警 issues_mgmt_associated_type_3000：WarRoom **默认取值：** 不涉及 | | source_id | 否 | String | **参数解释：** 问题单来源工单单号。 **约束限制：** - 当ticket_type为issues_mgmt创建问题单时，该字段选填。 - 当source的值为issues_mgmt_associated_type_1000、issues_mgmt_associated_type_2000或issues_mgmt_associated_type_3000时，必填。需要填写关联的工单单号。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | fount_time | 否 | Long | **参数解释：** 发现时间，时间戳。 **约束限制：** 当ticket_type为issues_mgmt创建问题单时，该字段选填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | virtual_schedule_type | 否 | String | **参数解释：** 问题单处理人类型。 **约束限制：** 当ticket_type为issues_mgmt创建问题单时，该字段必填。 **取值范围：** 枚举值 - issues_mgmt_virtual_schedule_type_1000：排班 - issues_mgmt_virtual_schedule_type_2000：个人 **默认取值：** 不涉及 | | 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 | **参数解释：** 预案子类型。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填。 - 当任务类型change_scheme取值为change_scheme_runbook时，该值必填。 **取值范围：** 枚举值 CUSTOMIZATION：自定义作业 COMMUNAL：公共作业 **默认取值：** 不涉及 | | plan_task_id | 否 | String | **参数解释：** 需要执行的作业ID。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填。 - 当任务类型change_scheme取值为change_scheme_runbook时，该值必填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | plan_task_name | 否 | String | **参数解释：** 需要执行的作业名称。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填。 - 当任务类型change_scheme取值为change_scheme_runbook时，该值必填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | plan_task_params | 否 | String | **参数解释：** 执行作业时所需的参数信息。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填。 - 当任务类型change_scheme取值为change_scheme_runbook时，该值必填。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | is_start_process | 否 | Boolean | **参数解释：** 是否启动流程 - 此值为false时，创建出来的工单为草稿状态 - 此值默认为true，创建出来的工单状态为未受理状态 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sub_tickets | 否 | Array of [TicketCreateSubTicketInfo] objects | **参数解释：** 变更子单的信息，包含变更单涉及的服务和Region信息。 **约束限制：** - 当ticket_type为change创建变更单时，该字段必填且有效 - 当ticket_type非change时，该字段可置空 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3TicketCreateSubTicketInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | app_name | 否 | String | **参数解释：** 变更服务。 **约束限制：** 当target_type为change_scope时，该字段需传递对应的变更服务中文名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | region | 否 | String | **参数解释：** 变更Region。 **约束限制：** 当target_type为change_scope时，该字段需传递对应的变更RegionID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | target_type | 否 | String | **参数解释：** 目标选项信息，该值可传递不同的信息 - 当传递变更应用时，该值传递change_scope - 当传递变更计划时，该值传递child_ticket **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 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** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider_code | String | **参数解释：** 服务标识。 **取值范围：** 不涉及 **默认取值：** 049 | | error_code | String | **参数解释：** 请求响应代码。 **取值范围：** GOM.00000000\~GOM.00009999999 **默认取值：** GOM.00000000 | | error_msg | String | **参数解释：** 请求响应描述。 **取值范围：** 不涉及 | | data | [data] object | 返回体 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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，创建出来的工单状态为未受理状态。 **取值范围：** true/false **默认取值：** true | | ticket_id | String | **参数解释：** 新创建的工单单号。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | id | String | **参数解释：** 新创建的工单单号唯一ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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", "is_start_process" : true, "sub_tickets" : [ { "target_type" : "change_scope", "app_name" : "COC应用", "region" : "xxx" }, { "target_type" : "change_scope", "app_name" : "COC应用", "region" : "xxx" }, { "target_type" : "child_ticket", "target_value" : "xxx", "expected_start_time" : 1750755723000, "expected_end_time" : 1750842123000, "executors" : "005b950b4863447cb97cd77a89559c79", "cooperators" : "0064670859f74dc89398d676d95e3577" }, { "target_type" : "child_ticket", "target_value" : "xxx", "expected_start_time" : 1750755733000, "expected_end_time" : 1750842134000, "executors" : "005b950b4863447cb97cd77a89559c79", "cooperators" : "0064670859f74dc89398d676d95e3577" } ], "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** 请求成功。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "error_code" : "GOM.00000000", "error_msg" : null, "provider_code" : 4, "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** 服务器未能处理请求。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : 4, "data" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 | | 400 | 服务器未能处理请求。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。