All Products
Search

This Product

    Data Management:ListOrders

    Document Center

    Data Management:ListOrders

    Last Updated:Feb 10, 2026

    You can call ListOrders to retrieve a list of 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dms:ListOrders

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    Tenant ID. Get this value by calling GetUserActiveTenant or ListUserTenants.

    3***
    PluginType

    string

    No

    Ticket type. For valid values, see PluginType parameter description.

    DC_COMMON
    OrderResultType

    string

    No

    Search type. If you do not specify this parameter, the API returns tickets that you submitted (AS_COMMITTER) by default. Valid values:

    • AS_ADMIN: Dashboard view. You must have the administrator role.

    • AS_COMMITTER: Tickets you submitted.

    • AS_HANDLER: Tickets assigned to you for processing.

    • AS_OWNER: Tickets you processed.

    • AS_Related: Tickets related to you.

    Note

    • Set this parameter to AS_ADMIN.

    AS_COMMITTER
    SearchDateType

    string

    No

    Date filter. Valid values:

    • CREATE_TIME: Creation time.

    • MODIFY_TIME: Modification time.

    CREATE_TIME
    StartTime

    string

    No

    Start time.

    2022-04-08 11:00:00
    EndTime

    string

    No

    End time.

    2022-04-09 11:00:00
    SearchContent

    string

    No

    Search content.

    test
    OrderStatus

    string

    No

    Ticket status. Valid values:

    • ALL: All statuses.

    • FINISHED: Completed.

    • RUNNING: In progress.

    ALL
    PageSize

    integer

    No

    Number of items per page.

    10
    PageNumber

    integer

    No

    Page number to start from.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    Orders

    object

    Order

    array<object>

    Ticket list.

    object

    Comment

    string

    Ticket comment.

    test
    LastModifyTime

    string

    Last modification time of the ticket.

    2022-04-08 11:27:45
    StatusCode

    string

    Ticket status code. Valid values:

    • fail: Failed.

    • toaudit: Pending approval.

    • cancel: User canceled the ticket.

    • processing: In progress.

    • approved: Approved.

    • reject: Rejected.

    • success: Succeeded.

    • closed: Closed.

    success
    CreateTime

    string

    Ticket creation time.

    2022-04-08 11:15:46
    Committer

    string

    Ticket submitter.

    test
    CommitterId

    integer

    User ID of the ticket submitter.

    51****
    StatusDesc

    string

    Description of the ticket status.

    变更成功
    PluginType

    string

    Ticket type.

    DC_COMMON
    OrderId

    integer

    Ticket ID.

    51****
    TotalCount

    integer

    Total number of records.

    1
    RequestId

    string

    Request ID.

    427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
    ErrorCode

    string

    Error code.

    UnknownError
    ErrorMessage

    string

    Error message.

    UnknownError
    Success

    boolean

    Indicates whether the request succeeded. Valid values:

    • true: The request succeeded.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "Orders": {
    "Order": [
      {
        "Comment": "test",
        "LastModifyTime": "2022-04-08 11:27:45",
        "StatusCode": "success",
        "CreateTime": "2022-04-08 11:15:46",
        "Committer": "test",
        "CommitterId": 0,
        "StatusDesc": "变更成功",
        "PluginType": "DC_COMMON",
        "OrderId": 0
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.