Help Center/ Cloud Operations Center/ API Reference/ API/ Fault Management/ Incident Management/ Querying the list of simplified incidents
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Querying the list of simplified incidents

Function

This API is used to query the incident ticket list by page. The pagination parameters are limit and offset. This API does not support condition-based filtering of incident tickets except for pagination parameters. The returned list fields are simple, including only the incident ticket title, incident ticket ID, description, service ticket status, incident level, enterprise project ID, incident ticket source, creator, and owner.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:ticket:list

    List

    -

    -

    -

    -

URI

GET /v1/incident-tickets

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition:

Pagination parameter of the API for querying lists. The value 1 indicates that the first page is queried.

Constraints:

N/A

Value range:

1-2147483647

Default value:

N/A

limit

No

Integer

Definition:

Parameters on each page queried by the API, indicating the number of records queried on a page. The value must be an integer greater than or equal to 1, indicating the maximum number of records that can be queried on each page during query by page.

Constraints:

N/A

Value range:

1-100

Default value:

50

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

provider_code

String

Definition:

Service ID.

Value range:

N/A

Default value:

049

error_code

String

Definition:

Request response code.

Value range:

GOM.00000000~GOM.00009999999

Default value:

GOM.00000000

error_msg

String

Definition:

Response description for a request.

Value range:

N/A

data

data object

Definition:

Information about the incident ticket found based on the conditions.

Value range:

N/A

Default value:

N/A
Table 3 data

Parameter

Type

Description

total

Long

Definition:

Total number of queried incident tickets.

Value range:

N/A

Default value:

N/A

IncidentSimpleTicketInfos

Array of IncidentSimpleTicketInfo objects

Definition:

Details about an incident ticket.

Value range:

N/A

Default value:

N/A
Table 4 IncidentSimpleTicketInfo

Parameter

Type

Description

title

String

Definition:

Title of an incident ticket.

Value range:

N/A

Default value:

N/A

ticket_id

String

Definition:

Incident ticket ID.

Value range:

N/A

Default value:

N/A

description

String

Definition:

Description of the incident ticket.

Value range:

N/A

Default value:

N/A

status

String

Definition:

Incident status.

Reference: Enumeration Incident Status incident_status

Value range:

N/A

Default value:

N/A

level

String

Definition:

Incident level.

For details, see the enumerated values of incident_level in Incident Level.

Value range:

N/A

Default value:

N/A

enterprise_project

String

Definition:

Enterprise project ID.

Value range:

N/A

Default value:

N/A

source

String

Definition:

Record source.

For details, see the enumerated values of incident_source in Incident Source.

Value range:

N/A

Default value:

N/A

creator

String

Definition:

Employee ID of the creator.

Value range:

N/A

Default value:

N/A

assignee

Array of strings

Definition:

Current owner. Multiple owners may exist. The content is the owner user ID.

Value range:

N/A

Default value:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

provider_code

String

Definition:

Service ID.

Value range:

N/A

Default value:

049

error_code

String

Definition:

Request response code.

Value range:

GOM.00000000~GOM.00009999999

Default value:

GOM.00000000

error_msg

String

Definition:

Response description for a request.

Value range:

N/A

Example Requests

Query simplified incident tickets.

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

Example Responses

Status code: 200

Request succeeded.

For more status codes, see Status Codes.

{
  "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" ]
    } ]
  }
}

Status code: 400

The server failed to process the request.

For more status codes, see Status Codes.

{
  "error_code" : "GOM.00007256",
  "error_msg" : "Invalid parameter",
  "provider_code" : 4,
  "data" : null
}

Status Codes

Status Code

Description

200

Request succeeded.

For more status codes, see Status Codes.

400

The server failed to process the request.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: Incident Management