Queries tickets in Data Management (DMS).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListOrders

The operation that you want to perform. Set the value to ListOrders.

Tid Long No 3000

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

PluginType String No DC_COMMON

The type of the tickets that you want to query. For more information, see PluginType parameter.

OrderResultType String No AS_ADMIN

The scope of the tickets that you want to query. Valid values:

  • AS_ADMIN: all tickets.
  • AS_COMMITTER: the tickets that are submitted by the current user.
  • AS_HANDLER: the tickets to be processed by the current user.
  • AS_OWNER: the tickets that are processed by the current user.
  • AS_Related: the tickets that are related to the current user.
SearchDateType String No CREATE_TIME

The time condition based on which you want to query tickets. Valid values:

  • CREATE_TIME: the time when a ticket was created.
  • MODIFY_TIME: the time when a ticket was last modified.
StartTime String No 2022-04-08 11:00:00

The beginning of the time range to query.

EndTime String No 2022-04-09 11:00:00

The end of the time range to query.

SearchContent String No test

The keyword that is used to query tickets.

OrderStatus String No ALL

The status of the tickets that you want to query. Valid values:

  • ALL: queries the tickets of all statuses.
  • FINISHED: queries the tickets that are completed.
  • RUNNING: queries the tickets that are being processed.
PageSize Integer No 10

The number of entries to return on each page.

PageNumber Integer No 1

The number of the page to return.

RegionId String No cn-hangzhou

The region in which DMS is activated. For more information, see RegionID parameter.

Response parameters

Parameter Type Example Description
Orders Array of order

The details about the tickets.

Order
Comment String test

The remarks of the ticket.

LastModifyTime String 2022-04-08 11:27:45

The time when the ticket was last modified.

StatusCode String success

The status code of the ticket. Valid values:

  • fail: The ticket fails to be executed.
  • toaudit: The ticket is waiting for approval.
  • cancel: The ticket is cancelled.
  • processing: The ticket is being executed.
  • approved: The ticket is approved.
  • reject: The ticket is rejected.
  • success: The ticket is executed.
  • closed: The ticket is closed.
CreateTime String 2022-04-08 11:15:46

The time when the ticket was created.

Committer String test

The user who submitted the ticket.

CommitterId Long 51****

The ID of the user who submitted the ticket.

StatusDesc String The change is successful.

The status description of the ticket.

PluginType String DC_COMMON

The type of the ticket.

OrderId Long 51****

The ID of the ticket.

TotalCount Long 1

The total number of entries that are returned.

RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.

ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListOrders
&Tid=3***
&PluginType=DC_COMMON
&OrderResultType=AS_ADMIN
&SearchDateType=CREATE_TIME
&StartTime=2019-10-10 00:00:00
&EndTime=2019-10-11 00:00:00
&SearchContent=test
&OrderStatus=ALL
&PageSize=10
&PageNumber=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListOrdersResponse>
    <Orders>
        <Comment>test</Comment>
        <LastModifyTime>2022-04-08 11:27:45</LastModifyTime>
        <StatusCode>success</StatusCode>
        <CreateTime>2022-04-08 11:15:46</CreateTime>
        <Committer>test</Committer>
        <StatusDesc>The change is successful.</StatusDesc>
        <PluginType>DC_COMMON</PluginType>
    </Orders>
    <TotalCount>1</TotalCount>
    <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</ListOrdersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Orders": [
    {
      "StatusDesc": "The change is successful.",
      "Comment": "test",
      "CreateTime": "2022-04-08 11:15:46",
      "Committer": "test_name",
      "OrderId": 5192547,
      "LastModifyTime": "2022-04-08 11:27:45",
      "PluginType": "DC_COMMON",
      "CommitterId": "51****",
      "StatusCode": "success"
    },
  ],
  "TotalCount": 1,
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.