文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 事件管理/ 查询简易版事件单列表 - ListIncidentSimpleTickets
更新时间：2025-10-23 GMT+08:00
查看PDF
分享

查询简易版事件单列表 - ListIncidentSimpleTickets

功能介绍

该接口可分页查询到事件单列表信息，分页参数为limit与offset。该接口不支持对事件单进行除分页参数外的条件过滤，且返回的列表字段相对简单，只有事件单标题、事件单单号、描述信息、工单状态、事件级别、企业项目ID、事件单来源、创建人及责任人。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:ticket:list

    List

    -

    -

    -

    -

URI

GET /v1/incident-tickets

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

列表查询接口分页参数，表示当前查询第几页，1表示查询第一页。

约束限制：

不涉及

取值范围：

1-2147483647

默认取值：

不涉及

最小值：1

最大值：2147483647

缺省值：1

limit

否

Integer

参数解释：

列表查询接口分页参数，表示一页查询多少条数据，该值需大于等于1且为整数，表示分页查询时每一页最多查到的数量。

约束限制：

不涉及

取值范围：

1-100

默认取值：

50

最小值：1

最大值：100

缺省值：50

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

不涉及

默认取值：

049

缺省值：049

最小长度：3

最大长度：100000000

error_code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

缺省值：GOM.00000000

最小长度：1

最大长度：15

error_msg

String

参数解释：

请求响应描述。

取值范围：

不涉及

最小长度：0

最大长度：100000000

data

data object

参数解释：

根据条件查到的事件单信息。

取值范围：

不涉及

默认取值：

不涉及

最小长度：0

最大长度：100
表3 data

参数

参数类型

描述

total

Long

参数解释：

查询到的事件单总数量。

取值范围：

不涉及

默认取值：

不涉及

最小值：0

最大值：9223372036854775807

IncidentSimpleTicketInfos

Array of IncidentSimpleTicketInfo objects

参数解释：

事件单工单详情信息。

取值范围：

不涉及

默认取值：

不涉及

数组长度：0 - 100
表4 IncidentSimpleTicketInfo

参数

参数类型

描述

title

String

参数解释：

事件单标题。

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：255

ticket_id

String

参数解释：

事件单单号。

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：255

description

String

参数解释：

事件单描述。

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：1024

status

String

参数解释：

事件状态。

参考：枚举 事件状态 incident_status

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：50

level

String

参数解释：

事件级别。

参考：枚举 事件级别 incident_level

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：50

enterprise_project

String

参数解释：

企业项目ID。

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：1000

source

String

参数解释：

单据来源。

参考：枚举 事件来源 incident_source

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：50

creator

String

参数解释：

创建人工号。

取值范围：

不涉及

默认取值：

不涉及

最小长度：1

最大长度：255

assignee

Array of strings

参数解释：

当前责任人，可能存在多个责任人使用列表展示，内容为责任人用户ID信息。

取值范围：

不涉及

默认取值：

不涉及

最小长度：0

最大长度：255

数组长度：0 - 200

状态码：400

表5 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

不涉及

默认取值：

049

缺省值：049

最小长度：3

最大长度：100000000

error_code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

缺省值：GOM.00000000

最小长度：1

最大长度：15

error_msg

String

参数解释：

请求响应描述。

取值范围：

不涉及

最小长度：0

最大长度：100000000

请求示例

查询简易版事件单列表。

https://{Endpoint}/v1/incident-tickets?offset=1&limit=10

响应示例

状态码：200

请求成功。

更多状态码请参考状态码。

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : 4,
  "data" : {
    "total" : 1,
    "IncidentSimpleTicketInfos" : [ {
      "title" : "incident title",
      "ticket_id" : "IM202506091611180193863384",
      "description" : "incident description",
      "status" : "INCIDENT_STATUS_TRIGGERED",
      "level" : "level_50",
      "enterprise_project" : "0",
      "source" : "incident_source_manual",
      "creator" : "653989085ba7487184d7cf219b8aa51e",
      "assignee" : [ "001427162ad8453ba6678d7cdb36bb59" ]
    } ]
  }
}

状态码：400

服务器未能处理请求。

更多状态码请参考状态码。

{
  "error_code" : "GOM.00007256",
  "error_msg" : "参数错误",
  "provider_code" : 4,
  "data" : null
}

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码。

400

服务器未能处理请求。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题： 事件管理

相关文档