Querying the Service Ticket List

Function

Query the list of service tickets.

URI

GET /v2/servicerequest/cases

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
search_key	No	Array	Specifies the keywords used for the query based on the brief description of service tickets. Multiple keywords separated by spaces can be used. Array length: 0 - 32
label_id_list	No	Array	Specifies the label list, which contains a maximum of 5 labels. Array length: 0 - 5
app_key	No	String	Specifies the keywords used for the query based on the IDs or brief description of service tickets. Minimum length: 0 Maximum length: 64
incident_id	No	String	Specifies the service ticket ID. Minimum length: 0 Maximum length: 64
query_start_time	No	String	Specifies the start time of the query. Minimum length: 0 Maximum length: 32
query_end_time	No	String	Specifies the end time of the query. Minimum length: 0 Maximum length: 32
status	No	Integer	Specifies the status. The options are 0 (to be processed), 1 (processing), 2 (to be confirmed), 3 (completed), 4 (canceled), 12 (invalid), and 17 (pending feedback). Minimum value: 0 Maximum value: 20
incident_status	No	String	Specifies the status list. Minimum length: 0 Maximum length: 32
x_customer_id	No	String	Specifies the sub-user ID. Minimum length: 0 Maximum length: 64
x_customer_name	No	String	Specifies the sub-user name. Minimum length: 0 Maximum length: 64
group_id	No	String	Specifies the group ID used by Huawei Cloud IAM. This ID is mandatory for operations on other service tickets in the same group. Minimum length: 0 Maximum length: 64
offset	No	Integer	Specifies the query offset. Minimum value: 0 Maximum value: 65535
limit	No	Integer	Specifies the quantity limit of the query. Minimum value: 0 Maximum value: 100

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000
X-Language	No	String	Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32
X-Time-Zone	No	String	Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Specifies the total number. Minimum value: 0 Maximum value: 65535
incident_info_list	Array of IncidentInfoV2 objects	Specifies the service ticket list. Array length: 0 - 65535

**Table 4** IncidentInfoV2
Parameter	Type	Description
xcustomer_id	String	Specifies the sub-user ID. Minimum length: 0 Maximum length: 64
xcustomer_name	String	Specifies the sub-user name. Minimum length: 0 Maximum length: 256
status	Integer	Specifies the status. The options are 0 (to be processed), 1 (processing), 2 (to be confirmed), 3 (completed), 4 (canceled), 12 (invalid), and 17 (pending feedback). Minimum value: 0 Maximum value: 20
incident_id	String	Specifies the service ticket ID. Minimum length: 0 Maximum length: 64
business_type_name	String	Specifies the problem type name. Minimum length: 0 Maximum length: 64
product_category_name	String	Specifies the product type name. Minimum length: 0 Maximum length: 64
incident_service_type	String	Specifies the service type name. Minimum length: 0 Maximum length: 64
incident_type_name	String	Specifies the service ticket type name. Minimum length: 0 Maximum length: 64
customer_id	String	Specifies the customer ID. Minimum length: 0 Maximum length: 64
dc_name	String	Specifies the region name. Minimum length: 0 Maximum length: 64
simple_description	String	Describes the service ticket briefly. Minimum length: 0 Maximum length: 2000
root_cause	String	Specifies the problem resolving department. Minimum length: 0 Maximum length: 256
resolution	String	Specifies the solution. Minimum length: 0 Maximum length: 2000
create_time	String	Specifies the creation time.
confirmed_time	String	Specifies the resolution time.
label_list	Array of LabelInfo objects	Specifies the label list. Array length: 0 - 5

**Table 5** LabelInfo
Parameter	Type	Description
label_id	Integer	Specifies the label ID. Minimum value: 0 Maximum value: 65535
name	String	Describes the label. Minimum length: 0 Maximum length: 64
color	String	Specifies the color ID. Minimum length: 0 Maximum length: 7

Request Example

None

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

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