All Products
Search
Document Center

Ticket System API:ListTickets

Last Updated:Aug 11, 2025

Retrieves a list of your tickets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

StartDate

integer

No

The start time when the ticket was created. Use this parameter with EndDate to query tickets created within a specific time range.

1623396736000

EndDate

integer

No

The end time when the ticket was created. Use this parameter with StartDate to query tickets created within a specific time range.

1623396736000

PageNumber

integer

Yes

The page number for a paged query.

1

PageSize

integer

Yes

The number of entries to return on each page.

10

TicketId

string

No

The ticket ID.

0005PYGCW

Keyword

string

No

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

ecs

StatusList

array

No

A list of ticket statuses.

6

string

No

The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait_feedback (Waiting for feedback), feedback (Feedback received), wait_confirm (Pending confirmation), and confirmed (Completed).

confirmed

TicketIdList

array

No

A list of ticket IDs.

string

No

The ticket ID.

0006S6ZL6E

Uid

string

No

The UID.

1902070573958003

Response parameters

Parameter

Type

Description

Example

object

AccessDeniedDetail

string

The details of the permission error. If you have the required permissions, an empty string is returned.

{\"AuthAction\":\"ram:ListTickets\",\"AuthPrincipalDisplayName\":\"2146216584788xxxxx\",\"AuthPrincipalOwnerId\":\"1135850448xxxxx\",\"AuthPrincipalType\":\"SubUser\",\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\"}

RequestId

string

The unique ID of the request. A unique ID is returned for each request.

AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD

Success

boolean

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

true

Code

integer

The return code of the request.

0

Message

string

The error message. This parameter is returned only when the value of success is false.

success

PageNumber

integer

The page number of the paged query.

1

PageSize

integer

The number of entries returned on each page.

10

TotalCount

integer

The total number of query results, which is the total number of your tickets.

99

Data

array<object>

The list of your tickets.

object

TicketId

string

The ticket ID.

0005PYGCW

Title

string

The ticket title.

Why ECS backup failed?

Status

object

The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait_feedback (Waiting for feedback), feedback (Feedback received), wait_confirm (Pending confirmation), and confirmed (Completed).

Label

string

The description of the status. Example: Completed.

Completed

Value

string

The value of the status. For example, a value of 6 indicates that the ticket is completed.

6

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{\\\"AuthAction\\\":\\\"ram:ListTickets\\\",\\\"AuthPrincipalDisplayName\\\":\\\"2146216584788xxxxx\\\",\\\"AuthPrincipalOwnerId\\\":\\\"1135850448xxxxx\\\",\\\"AuthPrincipalType\\\":\\\"SubUser\\\",\\\"NoPermissionType\\\":\\\"ImplicitDeny\\\",\\\"PolicyType\\\":\\\"AccountLevelIdentityBasedPolicy\\\"}",
  "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 code

Error code

Error message

Description

400 illegal.param Params illegal
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.
403 No permissions No permissions to access. RAM authentication does not have permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.