获取事件单详细
功能介绍
获取事件单详细。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/external/incident/{incident_num}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
incident_num |
是 |
String |
事件单号,事件单唯一id。 最小长度:0 最大长度:255 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
服务标识。 缺省值:049 最小长度:3 最大长度:100000000 |
error_code |
String |
请求响应代码,范围:GOM.00000000~GOM.00009999999,正常时取值:GOM.00000000。 缺省值:GOM.00000000 最小长度:1 最大长度:15 |
error_msg |
String |
请求响应描述。 最小长度:0 最大长度:100000000 |
data |
事件工单详情。 |
参数 |
参数类型 |
描述 |
---|---|---|
incident_num |
String |
事件单号。 最小长度:0 最大长度:255 |
region |
Array of strings |
区域Code,如果自动拉起WarRoom则为必填,现在只支持1个。 最小长度:0 最大长度:255 数组长度:0 - 1 |
enterprise_project |
Array of strings |
企业项目ID,现在只支持1个。 最小长度:0 最大长度:255 数组长度:0 - 1 |
current_cloud_service |
Array of strings |
归属应用ID,现在只支持1个。 最小长度:0 最大长度:255 数组长度:0 - 1 |
incident_level |
String |
事件级别 参考:枚举事件级别 最小长度:0 最大长度:255 |
is_service_interrupt |
Boolean |
业务是否中断,取值:true/false。 枚举值: |
start_time |
Long |
故障发生时间戳。 最小值:1 最大值:9999999999999 |
incident_type |
String |
事件类别 参考:枚举事件类别 最小长度:0 最大长度:255 |
incident_title |
String |
事件标题,最大长度:200。 最小长度:0 最大长度:200 |
incident_description |
String |
事件描述,最大长度:600。 最小长度:0 最大长度:600 |
incident_source |
String |
单据来源 参考:枚举事件类别 最小长度:0 最大长度:255 |
incident_ownership |
String |
事件归属 参考:枚举事件归属 最小长度:0 最大长度:255 |
incident_assignee |
Array of strings |
责任人,排班场景和排班角色不能同时为空,现在只支持1个。 最小长度:0 最大长度:255 数组长度:0 - 1 |
assignee_scene |
String |
排班场景,责任人和排班角色不能同时为空。 最小长度:0 最大长度:255 |
assignee_role |
String |
排班角色,排班场景和责任人不能同时为空。 最小长度:0 最大长度:255 |
warroom_id |
String |
warroom_id。 最小长度:0 最大长度:255 |
handle_time |
Long |
最后一次提交解决方案时间戳。 最小值:1 最大值:9999999999 |
status |
String |
状态KEY。 最小长度:0 最大长度:255 |
create_time |
Long |
创单时间戳。 最小值:0 最大值:999999999 |
creator |
String |
创单人。 最小长度:0 最大长度:255 |
enum_data_list |
Array of TicketInfoEnumData objects |
枚举列表。 数组长度:0 - 100000000 |
参数 |
参数类型 |
描述 |
---|---|---|
filed_key |
String |
字段KEY标识哪个字段。 最小长度:0 最大长度:255 |
enum_key |
String |
枚举KEY。 最小长度:0 最大长度:255 |
name_zh |
String |
中文名称。 最小长度:0 最大长度:255 |
name_en |
String |
英文名称。 最小长度:0 最大长度:255 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
服务标识。 缺省值:049 最小长度:3 最大长度:100000000 |
error_code |
String |
请求响应代码,范围:GOM.00000000~GOM.00009999999,正常时取值:GOM.00000000。 缺省值:GOM.00000000 最小长度:1 最大长度:15 |
error_msg |
String |
请求响应描述。 最小长度:0 最大长度:100000000 |
请求示例
获取事件单详细。
https://{Endpoint}/v1/external/incident/{incident_num}
响应示例
状态码:200
请求成功。
更多状态码请参考状态码。
{ "provider_code" : "049", "error_code" : "GOM.00000000", "error_msg" : null, "data" : { "incident_num" : "207E3F5A248A4F5DAABC012C7E", "region" : [ "***_cloud" ], "enterprise_project" : null, "current_cloud_service" : [ "6470681a31da2a47ed50a919" ], "incident_level" : "level_10", "is_service_interrupt" : true, "start_time" : null, "incident_type" : "inc_type_p_security_issues", "incident_title" : "FA3698893F", "incident_description" : "FA3698893F", "incident_source" : "incident_source_manual", "incident_ownership" : null, "incident_assignee" : [ "01649a08fb744291a952f3c470b92f9e" ], "assignee_scene" : "", "assignee_role" : "", "warroom_id" : null, "handle_time" : null, "status" : "INCIDENT_STATUS_TRIGGERED", "create_time" : 1700035856542, "creator" : "9fec03ee5b1040818b91bef6e16213df", "enum_data_list" : [ { "filed_key" : "current_cloud_service_id", "enum_key" : "6470681a31da2a47ed50a919", "name_zh" : null, "name_en" : null }, { "filed_key" : "creator", "enum_key" : "9fec03ee5b1040818b91bef6e16213df", "name_zh" : null, "name_en" : null }, { "filed_key" : "level_id", "enum_key" : "level_10", "name_zh" : "P1", "name_en" : "P1" }, { "filed_key" : "work_flow_status", "enum_key" : "INCIDENT_STATUS_TRIGGERED", "name_zh" : "未受理", "name_en" : "TRIGGERED" }, { "filed_key" : "mtm_type", "enum_key" : "inc_type_p_security_issues", "name_zh" : "安全问题", "name_en" : "Security issues" }, { "filed_key" : "source_id", "enum_key" : "incident_source_manual", "name_zh" : "人工创建", "name_en" : "Manual Creation" }, { "filed_key" : "assignee", "enum_key" : "01649a08fb744291a952f3c470b92f9e", "name_zh" : null, "name_en" : null } ] } }
状态码:400
服务器未能处理请求。
更多状态码请参考状态码。
{ "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : "049", "data" : null }
错误码
请参见错误码。