Help Center/Service Tickets/API Reference/API v2 (Recommended)/Basic Ticket Configuration Query/Querying the Service Ticket Category List
Updated on 2025-11-07 GMT+08:00
View PDF

Querying the Service Ticket Category List

Function

Query the list of service ticket categories.

URI

GET /v2/servicerequest/config/categories

Request Parameters

Table 1 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 2 Response body parameters

Parameter

Type

Description

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 65535

incident_sub_type_list

Array of IncidentSubTypeV2Do objects

Specifies the service ticket subtype list.

Array length: 0 - 65535

Table 3 IncidentSubTypeV2Do

Parameter

Type

Description

incident_sub_type_id

String

Specifies the service ticket subtype ID.

Minimum length: 1

Maximum length: 32

incident_sub_type_name

String

Specifies the service ticket subtype name.

Minimum length: 1

Maximum length: 64

incident_product_category_list

Array of IncidentProductCategoryV2 objects

Specifies the product type list.

Array length: 0 - 65535

Table 4 IncidentProductCategoryV2

Parameter

Type

Description

incident_product_category_id

String

Specifies the product type ID.

Minimum length: 1

Maximum length: 32

incident_product_category_name

String

Specifies the product type name.

Minimum length: 1

Maximum length: 64

incident_product_category_desc

String

Describes the product type.

Minimum length: 0

Maximum length: 512

incident_product_category_acronym

String

Specifies the product type abbreviation.

Minimum length: 0

Maximum length: 32

can_use_support_plan

Boolean

Specifies whether a support plan can be used.

Request Example

GET https://{endpoint}/v2/servicerequest/config/categories

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "total_count" : 1,
  "incident_sub_type_list" : [ {
    "incident_sub_type_id" : "123",
    "incident_sub_type_name" : "Computing",
    "incident_product_category_list" : [ {
      "incident_product_category_id" : "123",
      "incident_product_category_name" : "Elastic Cloud Server",
      "incident_product_category_desc" : "Virtual machine",
      "incident_product_category_acronym" : "ECS",
      "can_use_support_plan" : 1
    } ]
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.