All Products
Search
Document Center

Ticket System API:GetTicket

Last Updated:Dec 17, 2025

Queries the details of a ticket.

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

TicketId

string

Yes

The ticket ID.

001571BTXC

Uid

string

No

The UID.

1604499804113750

Response elements

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:GetTicket\",\"AuthPrincipalDisplayName\":\"2146216584788xxxxx\",\"AuthPrincipalOwnerId\":\"1135850448xxxxx\",\"AuthPrincipalType\":\"SubUser\",\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\"}

RequestId

string

The unique ID that Alibaba Cloud generates for the request.

C499BB0F-630D-5BE6-B3EA-5FCD95B85503

Success

boolean

Indicates whether the API call was successful. "true" indicates a successful call.

True

Code

integer

The return code of the API request.

0

Message

string

The error message. This parameter is returned when success=false.

success

PageNumber

integer

The page number of the paginated query.

1

PageSize

integer

The number of entries per page for the paginated query.

10

TotalCount

integer

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

108

Data

object

The business data returned after the API call is successful.

TicketId

string

The ticket ID.

0005PYGCW

Title

string

The ticket title.

Why ECS renewal failed?

Description

string

The description of the ticket. Only plain text is supported.

Why ECS renewal failed?

CreateTime

integer

The UNIX timestamp when the ticket was created.

1623396736000

CreatorId

string

The UID of the user who created the ticket.

1168025

CategoryId

string

The ID of the ticket category.

7161

Status

object

The status of the ticket. The following are the valid values:

1: assigned (To be processed)

2: dealing (Processing)

3: wait_feedback (Waiting for feedback)

4: feedback (Feedback received)

5: wait_confirm (To be confirmed)

6: confirmed (Completed)

Label

string

The status name.

Completed

Value

string

The status value.

6

Severity

object

The severity level. A value of 1 indicates a common issue. A value of 2 indicates an urgent issue.

Label

string

The severity name.

Common

Value

string

The severity value.

1

Examples

Success response

JSON format

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

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.