All Products
Search
Document Center

Ticket System API:GetTicket

Last Updated:Mar 30, 2026

Queries 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

Element

Type

Description

Example

object

AccessDeniedDetail

string

The details of the access denial. An empty string is returned if you have sufficient permissions.

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

RequestId

string

The request ID.

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

Success

boolean

Indicates whether the request was successful. A value of true indicates success.

True

Code

integer

The response code.

0

Message

string

The error message. Returned only when Success is false.

success

PageNumber

integer

The page number.

1

PageSize

integer

The number of entries per page.

10

TotalCount

integer

The total number of tickets.

108

Data

object

The data returned on success.

TicketId

string

The ticket ID.

0005PYGCW

Title

string

The ticket title.

ECS renewal failure

Description

string

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

ECS instance cannot start

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 label.

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 label.

Normal

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": "ECS renewal failure",
    "Description": "ECS instance cannot start",
    "CreateTime": 1623396736000,
    "CreatorId": "1168025",
    "CategoryId": "7161",
    "Status": {
      "Label": "Completed",
      "Value": "6"
    },
    "Severity": {
      "Label": "Normal",
      "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. You do not have RAM permissions to access this resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.