GetTicket - Ticket System API - Alibaba Cloud Documentation Center

Query tickets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TicketId	string	Yes	Work Order Number	001571BTXC
Uid	string	No	UID	1604499804113750

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	C499BB0F-630D-5BE6-B3EA-5FCD95B85503
Success	boolean	Indicates whether the call is successful. A value of true indicates that the call is normal.	True
Code	integer	The return code of the request result.	0
Message	string	The error message. If success is set to false, the message is returned.	success
PageNumber	integer	Page number of the paging query parameter	1
PageSize	integer	The number of entries per page in a pagination query parameter.	10
TotalCount	long	The total number of query results, that is, the total number of my ticket records.	108
Data	object	The data returned after the call succeeds.
TicketId	string	Work Order Number	0005PYGCW
Title	string	The title of the ticket.	Why ECS renewal failed?
Description	string	The description of the ticket. Only pure text format is supported.	Why ECS renewal failed?
CreateTime	long	The timestamp when the ticket was created.	1623396736000
CreatorId	string	The uid of the ticket creator.	1168025
CategoryId	string	The ID of the ticket issue category.	7161
Status	object	The status of the ticket. The reference values are as follows 1, "assigned", "Pending Response", 2, "handling", "handling", 3, "wait_feedback", "Pending feedback", 4: "feedback", "Feedback", 5, "wait_confirm", "To be confirmed", 6, "confirmed", "Completed"
Label	string	Status Enumeration Text	Completed
Value	string	State enumeration value	6
Severity	object	Urgency enumeration value, 1 for general problem, 2 for urgent problem
Label	string	Enumeration Text	Common
Value	string	Enumeration	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "C499BB0F-630D-5BE6-B3EA-5FCD95B85503",
  "Success": true,
  "Code": 0,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 108,
  "Data": {
    "TicketId": "0005PYGCW",
    "Title": "Why ECS renewal failed?",
    "Description": "Why ECS renewal failed?",
    "CreateTime": 1623396736000,
    "CreatorId": "1168025",
    "CategoryId": "7161",
    "Status": {
      "Label": "Completed",
      "Value": "6"
    },
    "Severity": {
      "Label": "Common",
      "Value": "1"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	illegal.param	Illegal param.	-
401	illegal.auth	You are not authorized to perform the operation.	You are not authorized to perform this operation.
500	System.error	An error occurred while processing your request.	An error occurred while processing your request. Please try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history