查询工单列表

功能介绍

查询工单列表

调试

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

URI

GET /v2/servicerequest/cases

表1 Query参数
参数	是否必选	参数类型	描述
search_key	否	Array	关键字查询（匹配工单简要描述）数组长度：0 - 3（单个长度不超过64）
label_id_list	否	Array	标签列表，最多支持5个数组长度：0 - 5
app_key	否	String	关键字查询（匹配工单id或者工单简要描述）最小长度：0 最大长度：64
incident_id	否	String	工单id 最小长度：0 最大长度：32
query_start_time	否	String	查询开始时间，格式：yyyy-MM-dd HH:mm:ss
query_end_time	否	String	查询结束时间，格式：yyyy-MM-dd HH:mm:ss
status	否	Integer	状态 0：待受理 1：处理中 2：待确认结果 3：已完成 4：已撤销 12：无效 17：待反馈
incident_status	否	String	状态列表
x_customer_id	否	String	子用户id 最小长度：0 最大长度：64
x_customer_name	否	String	子用户名称最小长度：0 最大长度：64
group_id	否	String	华为云IAM组id，涉及同组其他工单的操作时，该id必传最小长度：0 最大长度：64
offset	否	Integer	查询偏移量最小值：0 最大值：65535 缺省值：0
limit	否	Integer	查询限制数量最小值：0 最大值：100 缺省值：10
product_category_id	否	String	产品类型id 最小值：0 最大值：64
business_type_id	否	String	问题类型id 最小值：0 最大值：32
incident_sub_type_id	否	String	事件子类id 最小值：0 最大值：32
root_cause	否	String	问题归属最小值：0 最大值：32
incident_service_type	否	String	服务类型
trim_osm_rich_text_label	否	Boolean	是否去除富文本缺省值：true

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：5000
X-Language	否	String	语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。最小长度：1 最大长度：32
X-Time-Zone	否	String	环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。涉及时间的数据会根据环境时区处理。最小长度：1 最大长度：32

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
count	Integer	总数最小值：0 最大值：2147483647
incident_info_list	Array of IncidentInfoV2 objects	工单列表数组长度：0 - 65535

表4 IncidentInfoV2
参数	参数类型	描述
xcustomer_id	String	子用户id 最小长度：0 最大长度：64
xcustomer_name	String	子用户名称最小长度：0 最大长度：256
status	Integer	状态 0：待受理 1：处理中 2：待确认结果 3：已完成 4：已撤销 5：暂停 12：无效 13：已删除 17：待反馈最小值：0 最大值：20
incident_id	String	工单id 最小长度：0 最大长度：64
business_type_name	String	问题类型名称最小长度：0 最大长度：64
product_category_name	String	产品类型名称最小长度：0 最大长度：64
incident_service_type	String	服务类型名称最小长度：0 最大长度：64
incident_type_name	String	工单类型名称最小长度：0 最大长度：64
customer_id	String	客户id 最小长度：0 最大长度：64
dc_name	String	区域名称最小长度：0 最大长度：64
simple_description	String	简要描述最小长度：0 最大长度：2000
root_cause	String	问题归属最小长度：0 最大长度：256
resolution	String	解决方案最小长度：0 最大长度：2000
create_time	String	创建时间
confirmed_time	String	解决时间
label_list	Array of LabelInfo objects	标签列表数组长度：0 - 5
gray	Boolean	工单是否走灰度策略，true：走灰度策略 false：不走灰度策略
type	Integer	类型

表5 LabelInfo
参数	参数类型	描述
label_id	Integer	标签id 最小值：0 最大值：65535
name	String	标签描述最小长度：0 最大长度：64
color	String	颜色id 最小长度：0 最大长度：7

请求示例

无

响应示例

状态码： 200

成功

{
  "total_count" : 1,
  "incident_info_list" : [ {
    "xcustomer_id" : "test",
    "xcustomer_name" : "test",
    "status" : 0,
    "incident_id" : "test",
    "business_type_name" : "test",
    "incident_type_name" : "test",
    "customer_id" : "test",
    "dc_name" : "test",
    "simple_description" : "test",
    "create_time" : "test",
    "label_list" : [ {
      "label_id" : 1,
      "name" : "test",
      "color" : "test"
    } ]
  } ]
}