Querying Product Type List

Updated on 2022-12-12 GMT+08:00

View PDF

Function

Query the list of product types.

URI

GET /v2/servicerequest/config/product-categories

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
product_category_name	No	String	Specifies the product type name. Minimum length: 0 Maximum length: 64

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_product_category_list	Array of IncidentProductCategoryV2 objects	Specifies the product type list.

**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	Specifies the product type description. 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/product-categories?product_category_name=ECS

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "total_count" : 1,
  "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.

Parent topic: Basic Ticket Configuration Query

Previous topic: Querying Service Ticket Category List

Next topic: Querying Region List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot