调用ListOrders接口获取DMS工单信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListOrders

系统规定参数。取值：ListOrders。

Tid Long 否 3000

租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。

PluginType String 否 DC_COMMON

工单类型，取值请参见PluginType参数说明。

OrderResultType String 否 AS_ADMIN

搜索类型，取值如下：

  • AS_ADMIN：工单大盘
  • AS_COMMITTER：我发起的工单
  • AS_HANDLER：待我处理的工单
  • AS_OWNER：我已处理的工单
  • AS_Related：与我相关
SearchDateType String 否 CREATE_TIME

时间搜索条件，取值如下：

  • CREATE_TIME： 创建时间
  • MODIFY_TIME： 修改时间
StartTime String 否 2022-04-08 11:00:00

开始时间。
EndTime String 否 2022-04-09 11:00:00

结束时间。
SearchContent String 否 test

搜索内容。
OrderStatus String 否 ALL

工单状态，取值如下：

  • ALL：不限
  • FINISHED：已结束
  • RUNNING：进行中
PageSize Integer 否 10

每页数据量。
PageNumber Integer 否 1

开始页码。
RegionId String 否 cn-hangzhou

DMS服务地域，取值请参见RegionID参数说明。

返回数据

名称 类型 示例值 描述
Orders Array of Order

工单列表信息。
Order
Comment String test

工单备注信息。
LastModifyTime String 2022-04-08 11:27:45

工单最后修改时间。
StatusCode String success

工单状态码，返回值如下：

  • fail：执行失败
  • toaudit：等待审批
  • cancel：用户撤销工单
  • processing：执行中
  • approved：审批完成
  • reject：审批撤销
  • success：执行成功
  • closed：工单关闭
CreateTime String 2022-04-08 11:15:46

工单创建时间。
Committer String test

工单提交者。
CommitterId Long 51****

工单提交者的用户ID。
StatusDesc String 变更成功

工单状态描述。
PluginType String DC_COMMON

工单类型。
OrderId Long 51****

工单ID。
TotalCount Long 1

记录总数。
RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

请求ID。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式 

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>变更成功</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格式 

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

{
  "Orders": [
    {
      "StatusDesc": "变更成功",
      "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
}

错误码

访问错误中心查看更多错误码。