Searching Issue Tickets Based on Search Criteria_Issue Ticket Management_Fault Management_API_API Reference

Function

This API is used to return a service ticket list, indicating that the service tickets that meet the search criteria are found. The value of ticket_type must be issues_mgmt, indicating that issue tickets are searched.

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

POST /v1/{ticket_type}/list-tickets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
ticket_type	Yes	String	Definition: Type of the service ticket to be searched. The value is issues_mgmt for issue tickets. Constraints: 1–255 characters Value range: issues_mgmt Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
string_filters	No	Array of ObjectFilter objects	Definition: Search criteria of a character string. You can search for a specific ticket based on the criteria. Constraints: Array length: 0 to 20 Value range: N/A Default value: N/A
sort_filter	No	ObjectFilter object	Definition: Sorting condition of the searched historical records. The records can be sorted by the creation time of the operation records. Constraints: N/A Value range: N/A Default value: N/A
page	No	Integer	Definition: Number of the current page. The value 1 indicates that the first page is queried. Constraints: N/A Value range: N/A Default value: N/A
per_page	No	Integer	Definition: Number of records on the current page. Constraints: N/A Value range: N/A Default value: N/A
contain_all	No	Boolean	Definition: Whether all data on the current page is returned. Constraints: N/A Value range: true/false Default value: N/A
contain_total	No	Boolean	Definition: Whether the total number of records on the current page is returned. Constraints: N/A Value range: true/false Default value: true
contain_sub_ticket	No	Boolean	Definition: Whether the current page contains sub-tickets. Constraints: N/A Value range: true/false Default value: true
ticket_types	No	Array of strings	Definition: Type of the ticket searched on the current page. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** ObjectFilter
Parameter	Mandatory	Type	Description
operator	No	String	Definition: Operators include in, like, desc, startwith, endwith, =, !=, >, <, and more. Constraints: When you query a ticket ID, the operator is equal to, indicating that a specific ticket is searched for. When the query result is sorted, the operator is desc. Minimum length: 0 Maximum length: 20 Value range: N/A Default value: N/A
field	No	String	Definition: Name of the field to be operated. Constraints: When a ticket is queried, the field name is ticket_id. When the query result is sorted and filtered based on the creation time, the field name is start_time. Minimum length: 0 Maximum length: 255 Value range: N/A Default value: N/A
name	No	String	Definition: Name of the condition to be operated. Constraints: When a ticket is queried, the condition name is ticket_id. When the query result is sorted and filtered based on the creation time, the condition name is start_time. Minimum length: 0 Maximum length: 255 Value range: N/A Default value: N/A
values	No	Array of objects	Definition: Condition value that must be met when a field is operated. Constraints: When a ticket is queried, the condition value is the ticket ID. When the query result is sorted and filtered based on the creation time, the condition value is start_time. Array length: 0 to 1024 Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** 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: Ticket information found based on the search criteria. Constraints: N/A

**Table 5** data
Parameter	Type	Description
total	Long	Definition: Total number of tickets queried. Constraints: N/A
tickets	Array of CocTicketDetailInfoResponseData objects	Definition: Queried ticket information. Constraints: N/A
count_results	Array of longs	Definition: Data batch count. Constraints: N/A

**Table 6** CocTicketDetailInfoResponseData
Parameter	Type	Description
issue_correlation_sla	String	Definition: Issue ticket-associated SLA. Value range: N/A
level	String	Definition: Issue ticket level. Value range: N/A
root_cause_cloud_service	String	Definition: Responsible service of the issue ticket. Value range: N/A
root_cause_type	String	Definition: Root cause category of the issue ticket. Value range: N/A
current_cloud_service_id	String	Definition: Issue ticket service. Value range: N/A
issue_contact_person	String	Definition: Issue ticket contact person. Value range: N/A
issue_version	String	Definition: Version where the issue is found. Value range: N/A
source	String	Definition: Source of the issue ticket. Value range: N/A
commit_upload_attachment	String	Definition: ID of the uploaded attachment. Value range: N/A Default value: N/A
source_id	String	Definition: Source ID of the issue ticket. Value range: N/A
enterprise_project	String	Definition: Enterprise project of the issue ticket. Value range: N/A
virtual_schedule_type	String	Definition: Shift type of an issue ticket. Value range: N/A
title	String	Definition: Title of the issue ticket. Value range: N/A
regions	String	Definition: Region information of the issue ticket. Value range: N/A
description	String	Definition: Issue ticket description. Value range: N/A
root_cause_comment	String	Definition: Root cause analysis of the issue ticket. Value range: N/A
solution	String	Definition: Solution of the issue ticket. Value range: N/A
regions_serch	String	Definition: Value searched by region in the issue ticket. Value range: N/A
level_approve_config	String	Definition: Review configuration of the issue ticket level. Value range: N/A
suspension_approve_config	String	Definition: Review configuration of the issue ticket suspension. Value range: N/A
handle_time	Long	Definition: Issue ticket handling duration. Value range: N/A
fount_time	Long	Definition: Time when an issue ticket is found. Value range: N/A
is_common_issue	Boolean	Definition: Whether the issue is common. Value range: true/false
is_need_change	Boolean	Definition: Whether the issue ticket needs to be changed. Value range: true/false
is_enable_suspension	Boolean	Definition: Whether the issue ticket is suspended. Value range: true/false
is_start_process_async	Boolean	Definition: Whether to start the asynchronous process. Value range: true/false
is_update_null	Boolean	Definition: Whether to resubmit the empty field. Value range: true/false
creator	String	Definition: Issue ticket creator. Value range: N/A
operator	String	Definition: Operator of an issue ticket. Value range: N/A
is_return_full_info	Boolean	Definition: Whether to return all field information. Value range: true/false
is_start_process	Boolean	Definition: Whether to start the process. Value range: true/false
ticket_id	String	Definition: Issue ticket number. Value range: N/A
real_ticket_id	String	Definition: Issue ticket number. Value range: N/A
assignee	String	Definition: Current owner of the issue ticket. Value range: N/A
participator	String	Definition: Issue ticket participant. Value range: N/A
work_flow_status	String	Definition: Issue ticket status. Value range: N/A
engine_error_msg	String	Definition: Process status. Value range: N/A
baseline_status	String	Definition: Baseline status. Value range: N/A
ticket_type	String	Definition: Service ticket type. Value range: issues_mgmt
phase	String	Definition: Current phase of the issue ticket. Value range: N/A
sub_tickets	Array of sub_tickets objects	Definition: Change sub-ticket information. Value range: N/A
enum_data_list	Array of IssuesTicketInfoEnumData objects	Definition: Enumerated values associated with the issue ticket. Value range: N/A
id	String	Definition: Primary key UUID of an issue ticket. Value range: N/A
meta_data_version	Integer	Definition: Application version involved in the issue. Value range: N/A
update_time	Long	Definition: Timestamp when an issue ticket is updated. Value range: N/A
create_time	Long	Definition: Timestamp for issue ticket creation. Value range: N/A
is_deleted	Boolean	Definition: Whether the service ticket is deleted. Value range: N/A
ticket_type_id	String	Definition: Service ticket type. Value range: N/A
_form_info	Object	Definition: Action information. Value range: N/A Default value: N/A

**Table 7** sub_tickets
Parameter	Type	Description
change_ticket_id	String	Definition: ID of the associated change ticket. Value range: N/A
change_ticket_id_sub	String	Definition: Sub-ticket number of the change ticket. Value range: N/A
whether_to_change	Boolean	Definition: Whether a change is required Value range: N/A
is_deleted	Boolean	Definition: Whether it is deleted Value range: N/A
id	String	Definition: Change ticket ID. Value range: N/A
main_ticket_id	String	Definition: Primary key ID of the change ticket. Value range: N/A
parent_ticket_id	String	Definition: Parent ticket ID. Value range: N/A
ticket_id	String	Definition: Issue Ticket ID. Value range: N/A
real_ticket_id	String	Definition: Ticket number. Value range: N/A
ticket_path	String	Definition: Ticket path. Value range: N/A
target_value	String	Definition: Region information. Value range: N/A
target_type	String	Definition: Sub-ticket type. Value range: N/A
create_time	Long	Definition: Time when a service ticket is created. Value range: N/A
update_time	Long	Definition: Time when a ticket is updated. Value range: N/A
creator	String	Definition: ID of the ticket creator. Value range: N/A
operator	String	Definition: ID of the ticket operator. Value range: N/A

**Table 8** IssuesTicketInfoEnumData
Parameter	Type	Description
is_deleted	Boolean	Definition: Whether it is deleted Value range: N/A
match_type	String	Definition: Matched enumerated type. Value range: N/A
ticket_id	String	Definition: Current service ticket ID. Value range: N/A
real_ticket_id	String	Definition: Service ticket ID. Value range: N/A
name_zh	String	Definition: Chinese name. Value range: N/A
name_en	String	Definition: English name. Value range: N/A
biz_id	String	Definition: Unique ID of an enumerated value. When match_type is set to reference__base_config.User, the value of biz_id is the unique ID of the operator. Value range: N/A
prop_id	String	Definition: Type corresponding to the current enumerated value. Value range: N/A
model_id	String	Definition: Model ID corresponding to a background application. Value range: N/A

Status code: 400

**Table 9** 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

Search for the issue ticket ISU20250701163614016045039 created by the current user.

POST https://{Endpoint}/v1/issues_mgmt/list-tickets

{
  "page" : 1,
  "per_page" : 10,
  "sort_filter" : {
    "operator" : "desc",
    "field" : "create_time",
    "name" : "create_time",
    "values" : [ "create_time" ]
  },
  "string_filters" : [ {
    "operator" : "in",
    "field" : "creator",
    "name" : "creator_default",
    "values" : [ "96d9d36ef5e74f7aa54122586d5df0d5" ]
  }, {
    "operator" : "=",
    "field" : "ticket_id",
    "name" : "ticket_id",
    "values" : [ "ISU20250701163614016045039" ]
  } ],
  "contain_total" : true
}

Example Responses

Status code: 200

The request for searching for the issue ticket is successful.

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : 4,
  "data" : {
    "total" : 1,
    "tickets" : [ {
      "ticket_type" : "issues_type_1000",
      "issue_correlation_sla" : "ISU20250701163614016045039",
      "level" : "issues_level_4000",
      "root_cause_cloud_service" : "64881815b7cb4b2314f5ab12",
      "current_cloud_service_id" : "64881815b7cb4b2314f5ab12",
      "issue_contact_person" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "commit_upload_attachment" : "",
      "source_id" : "",
      "enterprise_project" : "0",
      "virtual_schedule_type" : "issues_mgmt_virtual_schedule_type_2000",
      "title" : "test",
      "regions" : "",
      "description" : "[Symptom] test\n[Impact on the live network]",
      "level_approve_config" : "{\"approve_role_type\":\"issue_creator_approve\",\"issue_approve_type\":\"issue_level_approve\",\"level\":\"issues_level_3000,issues_level_4000,issues_level_2000,issues_level_1000\",\"approve_rule\":\"issue_or_sign\",\"approve_personal\":\"5584d8abc2764fdbb45ef7fdda37cd50,bf1c440af2b240368fd98e46bb5c968c\",\"status\":true,\"is_start_process_async\":true,\"is_update_null\":false,\"creator\":\"78eded5f0f114f88a07504482e7dcd1b\",\"operator\":\"5e65c4eb605642938d6457255f41daf5\",\"is_return_full_info\":false,\"is_start_process\":true,\"ticket_id\":\"b4540a9c-03cb-4fe4-ad51-33951d870abc\",\"real_ticket_id\":\"20250614161245010463594140\",\"work_flow_status\":\"issue_process_control_draft\",\"engine_error_msg\":\"\",\"baseline_status\":\"issue_process_control_draft\",\"sub_tickets\":[],\"enum_data_list\":[],\"id\":\"2e1a17a21c5ab7e2dd0fcea03b2a7445\",\"meta_data_version\":0,\"update_time\":1750843183515,\"create_time\":1750843183515,\"is_deleted\":false,\"ticket_type_id\":\"issue_process_control\",\"_form_info\":{}}",
      "suspension_approve_config" : "{\"approve_role_type\":\"issue_creator_approve\",\"issue_approve_type\":\"issue_suspend_approve\",\"level\":\"\",\"approve_rule\":\"issue_or_sign\",\"approve_personal\":\"5584d8abc2764fdbb45ef7fdda37cd50,bf1c440af2b240368fd98e46bb5c968c\",\"status\":true,\"is_start_process_async\":true,\"is_update_null\":false,\"creator\":\"78eded5f0f114f88a07504482e7dcd1b\",\"operator\":\"5e65c4eb605642938d6457255f41daf5\",\"is_return_full_info\":false,\"is_start_process\":true,\"ticket_id\":\"20e3c48b-c74e-4819-b602-3da36933c200\",\"real_ticket_id\":\"20250614161250010088182250\",\"work_flow_status\":\"issue_process_control_draft\",\"engine_error_msg\":\"\",\"baseline_status\":\"issue_process_control_draft\",\"sub_tickets\":[],\"enum_data_list\":[],\"id\":\"02d45be207bb18e5f7786bf7af9dfbbf\",\"meta_data_version\":0,\"update_time\":1750843179194,\"create_time\":1750843179194,\"is_deleted\":false,\"ticket_type_id\":\"issue_process_control\",\"_form_info\":{}}",
      "handle_time" : 606768297,
      "fount_time" : 0,
      "is_start_process_async" : true,
      "is_update_null" : false,
      "creator" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "operator" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "is_return_full_info" : false,
      "is_start_process" : true,
      "ticket_id" : "ISU20250701163614016045039",
      "real_ticket_id" : "ISU20250701163614016045039",
      "assignee" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "participator" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "work_flow_status" : "issues_work_flow_status_2000",
      "engine_error_msg" : "",
      "baseline_status" : "issues_mgmt_draft",
      "phase" : "issues_phase_2000",
      "sub_tickets" : [ ],
      "enum_data_list" : [ {
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "Functional issues",
        "name_en" : "Functional issue",
        "biz_id" : "issues_type_1000",
        "prop_id" : "ticket_type",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "Individual",
        "name_en" : "Individuals",
        "biz_id" : "issues_mgmt_virtual_schedule_type_2000",
        "prop_id" : "virtual_schedule_type",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.User",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "coc_developer_test",
        "name_en" : "coc_developer_test",
        "user_name" : "coc_developer_test",
        "biz_id" : "96d9d36ef5e74f7aa54122586d5df0d5",
        "prop_id" : "creator",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.User",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "coc_developer_test",
        "name_en" : "coc_developer_test",
        "user_name" : "coc_developer_test",
        "biz_id" : "96d9d36ef5e74f7aa54122586d5df0d5",
        "prop_id" : "issue_contact_person",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.Resource",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "COC demo",
        "name_en" : "COC demo",
        "biz_id" : "64881815b7cb4b2314f5ab12",
        "prop_id" : "current_cloud_service_id",
        "model_id" : "TicketInfo"
      }, {
        "allow_actions" : "gocm_issues_workarounds_live_network_success",
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "Solution developing",
        "name_en" : "Locate the solution",
        "biz_id" : "issues_work_flow_status_2000",
        "prop_id" : "work_flow_status",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.Resource",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "COC demo",
        "name_en" : "COC demo",
        "biz_id" : "64881815b7cb4b2314f5ab12",
        "prop_id" : "root_cause_cloud_service",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "Tips",
        "name_en" : "Prompts",
        "biz_id" : "issues_level_4000",
        "prop_id" : "level",
        "model_id" : "TicketInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.User",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "coc_developer_test",
        "name_en" : "coc_developer_test",
        "user_name" : "coc_developer_test",
        "biz_id" : "96d9d36ef5e74f7aa54122586d5df0d5",
        "prop_id" : "assignee",
        "model_id" : "TicketInfo"
      } ],
      "id" : "d924a508d9c655145798e3e72cd3f6ae",
      "meta_data_version" : 39,
      "update_time" : 1751360968296,
      "create_time" : 1751358974724,
      "is_deleted" : false,
      "ticket_type_id" : "issues_mgmt",
      "_form_info" : { }
    } ],
    "count_results" : [ ]
  }
}

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	The request for searching for the issue ticket is successful.
400	The server failed to process the request. For more status codes, see Status Codes.

Status Code

Description

200

The request for searching for the issue ticket is successful.

400

The server failed to process the request.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Searching Issue Tickets Based on Search Criteria