调用ListOrders获取工单列表信息_数据管理(DMS)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3***
PluginType	string	否	工单类型，取值请参见 PluginType 参数说明。	DC_COMMON
OrderResultType	string	否	搜索类型。若您不填写此参数，则默认获取您发起的工单（AS_COMMITTER）信息。取值及说明如下： AS_ADMIN：工单大盘 AS_COMMITTER：我发起的工单 AS_HANDLER：待我处理的工单 AS_OWNER：我已处理的工单 AS_Related：与我相关	AS_COMMITTER
SearchDateType	string	否	时间搜索条件，取值如下： CREATE_TIME：创建时间 MODIFY_TIME：修改时间	CREATE_TIME
StartTime	string	否	开始时间。	2022-04-08 11:00:00
EndTime	string	否	结束时间。	2022-04-09 11:00:00
SearchContent	string	否	搜索内容。	test
OrderStatus	string	否	工单状态，取值如下： ALL：不限 FINISHED：已结束 RUNNING：进行中	ALL
PageSize	integer	否	每页数据量。	10
PageNumber	integer	否	开始页码。	1

返回参数

名称	类型	描述	示例值
	object
Orders	array<object>	工单列表信息。
	object
Comment	string	工单备注信息。	test
LastModifyTime	string	工单最后修改时间。	2022-04-08 11:27:45
StatusCode	string	工单状态码，返回值如下： fail：执行失败 toaudit：等待审批 cancel：用户撤销工单 processing：执行中 approved：审批完成 reject：审批撤销 success：执行成功 closed：工单关闭	success
CreateTime	string	工单创建时间。	2022-04-08 11:15:46
Committer	string	工单提交者。	test
CommitterId	long	工单提交者的用户 ID。	51****
StatusDesc	string	工单状态描述。	变更成功
PluginType	string	工单类型。	DC_COMMON
OrderId	long	工单 ID。	51****
TotalCount	long	记录总数。	1
RequestId	string	请求 ID。	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史