All Products
Search
Document Center

Ticket System API:ListTickets

Last Updated:Jul 22, 2024

You can call this operation to obtain the list of my tickets.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StartDatelongYes

The time when the ticket was created. This parameter is used with EndDate to query tickets that are created within the specified start and end time ranges.

1623396736000
EndDatelongYes

The deadline for ticket creation. This parameter is used in conjunction with StartDate to query tickets submitted within the specified start and end time ranges.

1623396736000
PageNumberintegerYes

Paging query page number parameters

1
PageSizeintegerYes

The number of entries queried by page parameter

10
TicketIdstringNo

Work Order Number

0005PYGCW
KeywordstringNo

The ticket keyword, which is used for fuzzy search to match the content of the Description field when a ticket is created.

ecs
StatusListarrayNo

Multiple ticket statuses

stringNo

The ticket status. Valid values: 1,"assigned","To be responded",2,"dealing","processing",3,"wait-feedback","To be responded",4,"feedback","Feedback",5,"wait_confirm","To be confirmed",6,"confirmed","Completed"

confirmed
TicketIdListarrayNo

Multiple job numbers

stringNo

The ticket ID.

0006S6ZL6E
UidstringNo

UID

1902070573958003

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The unique ID of the API request. The requestID is unique for each call.

AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Successboolean

Indicates whether the call is successful. A value of true indicates that the call is normal.

true
Codeinteger

The return code of the request result.

0
Messagestring

The error message. If success is set to false, the message is returned.

success
PageNumberinteger

Page number of the paging query parameter

1
PageSizeinteger

The number of entries per page in a pagination query parameter.

10
TotalCountlong

The total number of query results, that is, the total number of my ticket records.

99
Dataarray<object>

The return value is my ticket list data.

object
TicketIdstring

Work Order Number

0005PYGCW
Titlestring

The title of the ticket.

Why ECS backup failed?
Statusobject

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"

Labelstring

Status description, if completed

Completed
Valuestring

A status value, such as 6, represents completed

6

Examples

Sample success responses

JSONformat

{
  "RequestId": "AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD",
  "Success": true,
  "Code": 0,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 99,
  "Data": [
    {
      "TicketId": "0005PYGCW",
      "Title": "Why ECS backup failed?",
      "Status": {
        "Label": "Completed",
        "Value": "6"
      }
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400illegal.paramParams illegal-
401illegal.authYou are not authorized to perform the operation.You are not authorized to perform this operation.
500System.errorAn 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 timeSummary of changesOperation
No change history