All Products
Search
Document Center

Data Management:ListOrders

Last Updated:Apr 18, 2024

Queries tickets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListOrdersRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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

3000
PluginTypestringNo

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

DC_COMMON
OrderResultTypestringNo

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.
AS_ADMIN
SearchDateTypestringNo

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.
CREATE_TIME
StartTimestringNo

The beginning of the time range to query.

2022-04-08 11:00:00
EndTimestringNo

The end of the time range to query.

2022-04-09 11:00:00
SearchContentstringNo

The keyword that is used to query tickets.

test
OrderStatusstringNo

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.
ALL
PageSizeintegerNo

The number of entries to return on each page.

10
PageNumberintegerNo

The number of the page to return.

1

Response parameters

ParameterTypeDescriptionExample
object
Ordersobject []

The details about the tickets.

Commentstring

The remarks of the ticket.

test
LastModifyTimestring

The time when the ticket was last modified.

2022-04-08 11:27:45
StatusCodestring

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.
success
CreateTimestring

The time when the ticket was created.

2022-04-08 11:15:46
Committerstring

The user who submitted the ticket.

test
CommitterIdlong

The ID of the user who submitted the ticket.

51****
StatusDescstring

The status description of the ticket.

changed successfully
PluginTypestring

The type of the ticket.

DC_COMMON
OrderIdlong

The ID of the ticket.

51****
TotalCountlong

The total number of entries that are returned.

1
RequestIdstring

The ID of the request.

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

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "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": "changed successfully",
        "PluginType": "DC_COMMON",
        "OrderId": 0
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history