文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 问题单管理/ 根据条件搜索问题工单列表
更新时间:2025-08-01 GMT+08:00
分享

根据条件搜索问题工单列表

功能介绍

该接口返回工单列表,表示通过一定的搜索条件搜索到满足要求的工单。当前ticket_type需传值issues_mgmt表示搜索问题单。

调试

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

URI

POST /v1/{ticket_type}/list-tickets

表1 路径参数

参数

是否必选

参数类型

描述

ticket_type

String

参数解释:

需要搜索的工单类型,查询问题单列表传值issues_mgmt。

约束限制:

字符串 1 - 255字符

取值范围:

issues_mgmt

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

string_filters

Array of ObjectFilter objects

参数解释:

字符串搜索条件,可根据该条件搜索到具体的工单。

约束限制:

数组长度:0 - 20

取值范围:

不涉及

默认取值:

不涉及

sort_filter

ObjectFilter object

参数解释:

查询到的历史记录排序条件,可根据操作记录的创建时间进行排序。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

page

Integer

参数解释:

当前查询的页数,其中1表示查询第一页。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

per_page

Integer

参数解释:

当前页每页数量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

contain_all

Boolean

参数解释:

当前页是否返回所有数据。

约束限制:

不涉及

取值范围:

true/false

默认取值:

不涉及

contain_total

Boolean

参数解释:

当前页是否返回总数。

约束限制:

不涉及

取值范围:

true/false

默认取值:

true

contain_sub_ticket

Boolean

参数解释:

当前页是否包含子单。

约束限制:

不涉及

取值范围:

true/false

默认取值:

true

ticket_types

Array of strings

参数解释:

当前页搜索的工单类型。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 ObjectFilter

参数

是否必选

参数类型

描述

operator

String

参数解释:

操作符包括in/like/desc/startwith/endwith/=/!=/>/<等。

约束限制:

当查询某一工单单号时,操作符为=,表示搜索特定工单。当对查询结果进行排序时,操作符为desc。

最小长度:0

最大长度:20

取值范围:

不涉及

默认取值:

不涉及

field

String

参数解释:

需要操作的字段名称。

约束限制:

当查询工单时,字段名称为ticket_id,当对查询结果根据创建时间排序过滤时,字段名称为start_time。

最小长度:0

最大长度:255

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

需要操作的条件名称。

约束限制:

当查询工单时,条件名称为ticket_id,当对查询结果根据创建时间排序过滤时,条件名称为start_time。

最小长度:0

最大长度:255

取值范围:

不涉及

默认取值:

不涉及

values

Array of objects

参数解释:

表示对某个filed进行某种操作时,需要满足的条件值。

约束限制:

当查询工单时,条件值为工单id,当对查询结果根据创建时间排序过滤时,条件值为start_time。

数组长度:0 - 1024

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释:

服务标识。

取值范围:

不涉及

默认取值:

049

error_code

String

参数解释:

请求响应代码。

取值范围:

GOM.00000000~GOM.00009999999

默认取值:

GOM.00000000

error_msg

String

参数解释:

请求响应描述。

取值范围:

不涉及

data

data object

参数解释:

根据条件查询到的工单信息。

约束限制:

不涉及

表5 data

参数

参数类型

描述

total

Long

参数解释:

查询到的工单总数。

约束限制:

不涉及

tickets

Array of CocTicketDetailInfoResponseData objects

参数解释:

查询到的工单信息。

约束限制:

不涉及

count_results

Array of longs

参数解释:

数据批量计数。

约束限制:

不涉及

表6 CocTicketDetailInfoResponseData

参数

参数类型

描述

issue_correlation_sla

String

参数解释:

问题关联SLA。

取值范围:

不涉及

level

String

参数解释:

问题单级别。

取值范围:

不涉及

root_cause_cloud_service

String

参数解释:

问题单责任服务。

取值范围:

不涉及

root_cause_type

String

参数解释:

问题单根因分类。

取值范围:

不涉及

current_cloud_service_id

String

参数解释:

问题单服务。

取值范围:

不涉及

issue_contact_person

String

参数解释:

问题单接口人。

取值范围:

不涉及

issue_version

String

参数解释:

发现问题版本号。

取值范围:

不涉及

source

String

参数解释:

问题单来源。

取值范围:

不涉及

commit_upload_attachment

String

参数解释:

上传的附件ID。

取值范围:

不涉及

默认取值:

不涉及

source_id

String

参数解释:

问题单来源id。

取值范围:

不涉及

enterprise_project

String

参数解释:

问题单企业项目。

取值范围:

不涉及

virtual_schedule_type

String

参数解释:

问题单排班类型。

取值范围:

不涉及

title

String

参数解释:

问题单标题。

取值范围:

不涉及

regions

String

参数解释:

问题单region信息。

取值范围:

不涉及

description

String

参数解释:

问题单描述。

取值范围:

不涉及

root_cause_comment

String

参数解释:

问题单根因分析。

取值范围:

不涉及

solution

String

参数解释:

问题单解决方案。

取值范围:

不涉及

regions_serch

String

参数解释:

问题单区域搜索的值。

取值范围:

不涉及

level_approve_config

String

参数解释:

问题单级别审批配置。

取值范围:

不涉及

suspension_approve_config

String

参数解释:

问题单挂起审批配置。

取值范围:

不涉及

handle_time

Long

参数解释:

问题单处理时长。

取值范围:

不涉及

fount_time

Long

参数解释:

问题单发现时间。

取值范围:

不涉及

is_common_issue

Boolean

参数解释:

是否共性问题。

取值范围:

true/false

is_need_change

Boolean

参数解释:

问题单是否需要变更。

取值范围:

true/false

is_enable_suspension

Boolean

参数解释:

问题单是否开启挂起。

取值范围:

true/false

is_start_process_async

Boolean

参数解释:

是否启动异步流程。

取值范围:

true/false

is_update_null

Boolean

参数解释:

是否重新提交空字段。

取值范围:

true/false

creator

String

参数解释:

问题单创建人。

取值范围:

不涉及

operator

String

参数解释:

问题单操作人。

取值范围:

不涉及

is_return_full_info

Boolean

参数解释:

是否返回所有字段信息。

取值范围:

true/false

is_start_process

Boolean

参数解释:

是否启动流程。

取值范围:

true/false

ticket_id

String

参数解释:

问题单工单单号。

取值范围:

不涉及

real_ticket_id

String

参数解释:

问题单工单单号。

取值范围:

不涉及

assignee

String

参数解释:

问题单当前责任人。

取值范围:

不涉及

participator

String

参数解释:

问题单参与人。

取值范围:

不涉及

work_flow_status

String

参数解释:

问题单状态。

取值范围:

不涉及

engine_error_msg

String

参数解释:

流程状态。

取值范围:

不涉及

baseline_status

String

参数解释:

基线状态。

取值范围:

不涉及

ticket_type

String

参数解释:

工单类型。

取值范围:

issues_mgmt

phase

String

参数解释:

问题单当前阶段信息。

取值范围:

不涉及

sub_tickets

Array of sub_tickets objects

参数解释:

变更子单信息。

取值范围:

不涉及

enum_data_list

Array of IssuesTicketInfoEnumData objects

参数解释:

问题单关联的枚举列表。

取值范围:

不涉及

id

String

参数解释:

问题单主键uuid。

取值范围:

不涉及

meta_data_version

Integer

参数解释:

问题当的应用版本。

取值范围:

不涉及

update_time

Long

参数解释:

问题单更新时间戳。

取值范围:

不涉及

create_time

Long

参数解释:

问题单创单时间戳。

取值范围:

不涉及

is_deleted

Boolean

参数解释:

工单是否被删除。

取值范围:

不涉及

ticket_type_id

String

参数解释:

工单类型。

取值范围:

不涉及

_form_info

Object

参数解释:

动作信息。

取值范围:

不涉及

默认取值:

不涉及

表7 sub_tickets

参数

参数类型

描述

change_ticket_id

String

参数解释:

关联的变更单单号。

取值范围:

不涉及

change_ticket_id_sub

String

参数解释:

变更子单单号。

取值范围:

不涉及

whether_to_change

Boolean

参数解释:

是否需要变更。

取值范围:

不涉及

is_deleted

Boolean

参数解释:

是否已删除。

取值范围:

不涉及

id

String

参数解释:

变更工单ID

取值范围:

不涉及

main_ticket_id

String

参数解释:

变更工单主键ID。

取值范围:

不涉及

parent_ticket_id

String

参数解释:

父级工单ID。

取值范围:

不涉及

ticket_id

String

参数解释:

问题单ID。

取值范围:

不涉及

real_ticket_id

String

参数解释:

问题单单号。

取值范围:

不涉及

ticket_path

String

参数解释:

工单路径。

取值范围:

不涉及

target_value

String

参数解释:

region信息。

取值范围:

不涉及

target_type

String

参数解释:

子单类型。

取值范围:

不涉及

create_time

Long

参数解释:

工单创建时间。

取值范围:

不涉及

update_time

Long

参数解释:

工单更新时间。

取值范围:

不涉及

creator

String

参数解释:

工单创建人ID。

取值范围:

不涉及

operator

String

参数解释:

工单操作人ID。

取值范围:

不涉及

表8 IssuesTicketInfoEnumData

参数

参数类型

描述

is_deleted

Boolean

参数解释:

是否已删除。

取值范围:

不涉及

match_type

String

参数解释:

匹配的枚举类型。

取值范围:

不涉及

ticket_id

String

参数解释:

当前工单ID。

取值范围:

不涉及

real_ticket_id

String

参数解释:

工单单号。

取值范围:

不涉及

name_zh

String

参数解释:

中文名称。

取值范围:

不涉及

name_en

String

参数解释:

英文名称。

取值范围:

不涉及

biz_id

String

参数解释:

枚举值对应的唯一id,当match_type为reference__base_config.User时,biz_id的值为操作用户唯一Id。

取值范围:

不涉及

prop_id

String

参数解释:

当前枚举值对应的类型。

取值范围:

不涉及

model_id

String

参数解释:

后台不同应用对应的模型id。

取值范围:

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释:

服务标识。

取值范围:

不涉及

默认取值:

049

error_code

String

参数解释:

请求响应代码。

取值范围:

GOM.00000000~GOM.00009999999

默认取值:

GOM.00000000

error_msg

String

参数解释:

请求响应描述。

取值范围:

不涉及

请求示例

搜索创建者为当前用户且单号为ISU20250701163614016045039的问题单。

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
}

响应示例

状态码:200

搜索问题单请求成功。

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : "049",
  "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" : "【问题现象】test\n【问题对现网的影响】",
      "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" : "功能性问题",
        "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" : "个人",
        "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演示",
        "name_en" : "COC演示",
        "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" : "定位出方案中",
        "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演示",
        "name_en" : "COC演示",
        "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" : "提示",
        "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" : [ ]
  }
}

状态码:400

服务器未能处理请求。

更多状态码请参考状态码

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

状态码

状态码

描述

200

搜索问题单请求成功。

400

服务器未能处理请求。

更多状态码请参考状态码

错误码

请参见错误码

相关文档