# 查询事件单列表 - ListIncidents #### 功能介绍 查询事件对象列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListIncidents)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:ticket:list | List | - | - | - | - | #### URI POST /v2/incidents/list #### 请求参数 表1请求body参数 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | page | Integer | 否 | **参数解释：** 查询事件单列表接口分页参数，表示当前的页数，默认查询第一页的数据。 **约束限制：** 不涉及 **取值范围：** 1-1000000 **默认取值：** 1 | | per_page | Integer | 否 | **参数解释：** 查询事件单列表接口分页参数，表示每页查询到的事件单数量。 **约束限制：** 不涉及 **取值范围：** 1-200 **默认取值：** 10 | | contain_all | Boolean | 否 | **参数解释：** 是否返回所有数据。 **约束限制：** 不涉及 **取值范围：** true/false **默认取值：** false | | contain_total | Boolean | 否 | **参数解释：** 查询到的结果中是否包含当前条件下可以查到的事件单总数量。 **约束限制：** 不涉及 **取值范围：** true/false **默认取值：** true | | contain_sub_ticket | Boolean | 否 | **参数解释：** 查询结果中是否包括子单信息。 **约束限制：** 不涉及 **取值范围：** true/false **默认取值：** true | | string_filters | Array of [ObjectFilterV2] | 否 | **参数解释：** 查询事件单的条件过滤器。 **约束限制：** 数组的长度最多20。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sort_filter | [ObjectFilterV2] object | 否 | **参数解释：** 查询事件单的排序过滤器。 **约束限制：** 数组的长度最多10。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | condition | String | 否 | **参数解释：** 表达式，对复杂表达式进行组装，可以用英文括号()、与\&、或\|。 示例：( filterName1 \& filterName2) \| filterName3。 filterName\*：取自string_filters ObjectFilter.name。 如果为空，string_filters中的条件默认是与的关系 **约束限制：** 字符串 **取值范围：** 1-10000 **默认取值：** 不涉及 | | count_filters | Array of [CountFilterV2] | 否 | **参数解释：** 统计工单数量过滤器。 **约束限制：** 数组长度：**0 - 10** **取值范围：** 不涉及 **默认取值：** 不涉及 | | fields | Array of String | 否 | **参数解释：** 指定接口返回的字段。 **约束限制：** 数组长度：**0 - 100** **取值范围：** 不涉及 **默认取值：** 不涉及 | | group_by_filter | [ObjectFilterV2] object | 否 | **参数解释：** 分组过滤器。 **约束限制：** 数组长度：**0 - 20** **取值范围：** 不涉及 **默认取值：** 不涉及 | | int_filters | Array of [ObjectFilterV2] | 否 | **参数解释：** 整形过滤器。 **约束限制：** 数组长度：**0 - 20** **取值范围：** 不涉及 **默认取值：** 不涉及 | | ticket_types | Array of String | 否 | **参数解释：** 需要查询的工单类型，获取事件列表的场景下此处传递的值为incident。 **约束限制：** 数组长度：**0 - 5** **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2CountFilterV2参数： | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | name | String | 否 | **参数解释：** 过滤器名称，用于condition表达式拼接。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | | filters | Array of [ObjectFilterV2] | 否 | **参数解释：** 统计数量过滤器。 **约束限制：** 数组长度：**0 - 10** **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3ObjectFilterV2参数列表： | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | name | String | 否 | **参数解释：** 过滤器名称，用于condition表达式拼接。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | | field | String | 是 | **参数解释：** 字段KEY，取值参考[表4 ListIncidentsResponseBodyData参数列表]。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | | operator | String | 是 | **参数解释：** 操作符，取值：in/like/startwith/endwith/=/!=/\>/\<。 **约束限制：** 字符串 **取值范围：** 0-20 **默认取值：** 不涉及 | | values | Arrays of String | 是 | **参数解释：** 需要过滤的值，值的内容支持String，时间戳，枚举，整形，全部以字符串的形式进行传递。 **约束限制：** 数组长度：1 - 1024 元素字符长度： 最小长度：0 最大长度： 1024 **取值范围：** 不涉及 **默认取值：** 不涉及 | | group | String | 否 | **参数解释：** 分组查询信息。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | | match_type | String | 否 | **参数解释：** 匹配方式。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | | priority_type | String | 否 | **参数解释：** 优先级处理方式。 **约束限制：** 字符串 **取值范围：** 0-255 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数列表 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | provider_code | String | 否 | **参数解释：** 服务标识。 **取值范围：** 最小长度：0 最大长度：256 **默认取值：** 049 | | error_code | String | 否 | **参数解释：** 请求响应代码，范围：0000\~9999，正常时取值：0。 **取值范围：** 字符长度0-256 **默认取值：** 0 | | error_msg | String | 否 | **参数解释：** 请求响应描述。 **取值范围：** 字符长度0-256 **默认取值：** 不涉及 | | data | [ListIncidentsResponseBodyData] object | 否 | **参数解释：** 搜索结果。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表5ListIncidentsResponseBodyData参数列表 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | total | Long | 否 | **参数解释：** 查询到的事件单工单总数量。 **取值范围：** 长度1-9999999999999 **默认取值：** 0 | | tickets | Arrays of [IncidentDataInfo] | 否 | **参数解释：** 结果数据列表。 **取值范围：** 数组长度：1 - 1000 **默认取值：** 不涉及 | | count_results | Arrays of Long | 否 | **参数解释：** 工单数量统计结果。 **取值范围：** 数组长度：1 - 1000 **默认取值：** 不涉及 | 表6IncidentDataInfo参数列表 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | current_cloud_service_id | String | 否 | **参数解释：** 云服务ID。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | level_id | String | 否 | **参数解释：** 事件等级，参考 事件相关枚举信息中的[事件级别](https://support.huaweicloud.com/api-coc/coc_api_04_03_001_006.html#coc_api_04_03_001_006__section289718103710)。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | mtm_region | String | 否 | **参数解释：** 区域Region。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | source_id | String | 否 | **参数解释：** 事件来源，参考事件相关枚举信息中的[事件来源](https://support.huaweicloud.com/api-coc/coc_api_04_03_001_006.html#coc_api_04_03_001_006__section10172124616391)。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | forward_rule_id | String | 否 | **参数解释：** 转发规则。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | enterprise_project_id | String | 否 | **参数解释：** 企业项目ID。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | mtm_type | String | 否 | **参数解释：** 事件类别，参考事件相关枚举信息中的[事件类别](https://support.huaweicloud.com/api-coc/coc_api_04_03_001_006.html#coc_api_04_03_001_006__section137541363918)。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | title | String | 否 | **参数解释：** 事件标题。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | description | String | 否 | **参数解释：** 事件描述。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | ticket_id | String | 否 | **参数解释：** 事件单号。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | is_service_interrupt | String | 否 | **参数解释：** 服务是否中断。 **取值范围：** true/false **默认取值：** 不涉及 | | work_flow_status | String | 否 | **参数解释：** 事件单当前的状态，枚举值。 **取值范围：** 枚举值 - INCIDENT_STATUS_ACKNOWLEDGED：已受理 - INCIDENT_STATUS_CLOSED：客户已关闭 - INCIDENT_STATUS_COMPLETED：已完成 - INCIDENT_STATUS_REJECTED：被驳回 - INCIDENT_STATUS_RESOLVED：已解决待验证 - INCIDENT_STATUS_TRIGGERED：未受理 - level_approving：事件降级审批中 - pausing：暂停中 - pause_approving：事件暂停审批中 - ROS_CLEANUP_INCIDENT_CLOSED：租户退租事件单关闭 **默认取值：** 不涉及 | | phase | String | 否 | **参数解释：** 流程阶段。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | assignee | String | 否 | **参数解释：** 责任人。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | creator | String | 否 | **参数解释：** 创建人。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | operator | String | 否 | **参数解释：** 最后一次操作人。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | update_time | String | 否 | **参数解释：** 更新时间，时间戳。 **取值范围：** 字符长度1-50 **默认取值：** 不涉及 | | create_time | String | 否 | **参数解释：** 创建时间，时间戳。 **取值范围：** 字符长度1-50 **默认取值：** 不涉及 | | start_time | String | 否 | **参数解释：** 故障开始时间，时间戳。 **取值范围：** 字符长度1-50 **默认取值：** 不涉及 | | handle_time | String | 否 | **参数解释：** 处理时间，时间戳。 **取值范围：** 字符长度1-50 **默认取值：** 不涉及 | | incident_ownership | String | 否 | **参数解释：** 事件归属。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | enum_data_list | Arrays of [TicketInfoEnumData] | 否 | **参数解释：** 事件单枚举字段详细信息，包括事件单级别、创建人、责任人、事件归属等信息，其中prop_id表示枚举类型，biz_id表示枚举值唯一ID。 **取值范围：** 数组长度：1 - 1024 **默认取值：** 不涉及 | 表7TicketInfoEnumData参数列表 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | prop_id | String | 否 | **参数解释：** 标识枚举值类型。 **取值范围：** 枚举值 - current_cloud_service_id：事件单责任服务 - creator：事件单创建人 - incident_ownership：事件单归属 - level_id：事件单级别 - work_flow_status：事件单状态 - mtm_type：事件单类型 - source_id：事件单来源 - assignee：当前责任人 - mtm_region：事件单所属region **默认取值：** 不涉及 | | biz_id | String | 否 | **参数解释：** 枚举对应的值，如当filed_key为creator且enum_key为test_id时，表示事件单创建人工号ID为test_id。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | name_zh | String | 否 | **参数解释：** 中文名称。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | | name_en | String | 否 | **参数解释：** 英文名称。 **取值范围：** 字符长度0-255 **默认取值：** 不涉及 | #### 请求示例 查询事件列表。 ``` POST https://{Endpoint}/v2/incidents/list { "page": 1, "per_page": 10, "sort_filter": { "operator": "desc", "field": "create_time", "name": "create_time", "values": [ "create_time" ] }, "string_filters": [ { "operator": "in", "field": "assignee", "name": "assignee_default", "values": [ "653989085ba7487184d7cf219b8aa51e" ] }, { "operator": "in", "field": "approver", "name": "approver_default", "values": [ "653989085ba7487184d7cf219b8aa51e" ] }, { "operator": "in", "field": "work_flow_status", "name": "work_flow_status_default", "values": [ "incident_draft", "INCIDENT_STATUS_ACKNOWLEDGED", "INCIDENT_STATUS_REJECTED", "INCIDENT_STATUS_RESOLVED", "INCIDENT_STATUS_TRIGGERED", "pausing", "level_approving" ] }, { "operator": "in", "field": "work_flow_status", "name": "work_flow_status_approve", "values": [ "level_approving", "pause_approving" ] } ], "contain_total": true, "condition": "(work_flow_status_default & assignee_default) | (approver_default & work_flow_status_approve)" } ``` #### 响应示例 **状态码：200** 请求成功。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "provider_code": "049", "error_code": "GOM.00000000", "error_msg": null, "data": { "total": 1161, "tickets": [ { "current_cloud_service_id": "66431ed6ffed4e034ce18ff0", "level_id": "level_30", "mtm_region": "", "source_id": "incident_source_forwarding", "forward_rule_id": "1ccf2d2ae38b157ff103e84d710a9509", "enterprise_project_id": "0", "mtm_type": "inc_type_p_reliability_issues", "title": "CES自动执行响应预案_事件06", "description": "Condit****inutes", "handle_time": 315, "is_service_interrupt": false, "ticket_id": "IM202504101040380143525888", "assignee": "653989085ba7487184d7cf219b8aa51e", "work_flow_status": "INCIDENT_STATUS_TRIGGERED", "phase": "phase_incident_create", "enum_data_list": [ { "name_zh": "testApp1", "name_en": "testApp1", "biz_id": "66431ed6ffed4e034ce18ff0", "prop_id": "current_cloud_service_id" }, { "name_zh": "CES自动执行响应预案_事件06", "name_en": "CES自动执行响应预案_事件06", "biz_id": "1ccf2d2ae38b157ff103e84d710a9509", "prop_id": "forward_rule_id" }, { "name_zh": "P3", "name_en": "P3", "biz_id": "level_30", "prop_id": "level_id" }, { "name_zh": "未受理", "name_en": "TRIGGERED", "biz_id": "INCIDENT_STATUS_TRIGGERED", "prop_id": "work_flow_status" }, { "name_zh": "性能/可靠性问题", "name_en": "reliability issues", "biz_id": "inc_type_p_reliability_issues", "prop_id": "mtm_type" }, { "name_zh": "流转创建", "name_en": "Transfer creation", "biz_id": "incident_source_forwarding", "prop_id": "source_id" }, { "name_zh": "COC-Script", "name_en": "COC-Script", "biz_id": "653989085ba7487184d7cf219b8aa51e", "prop_id": "assignee" } ], "update_time": 1744252838924, "create_time": 1744252838072 } ] } } ``` **状态码：400** 服务器未能处理请求。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : "049", "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)。