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

调试

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

请求参数

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

系统规定参数。取值:ListOrders

Tid Long -1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
PluginType String DC_COMMON

工单类型,取值和说明如下:

  • PERM_APPLY:权限申请
  • OWNER_APPLY: owner申请
  • DATA_CORRECT:数据变更
  • NDDL:结构设计
  • DATA_TRACK:数据追踪
  • TABLE_SYNC:库表同步
  • DATA_EXPORT:数据导出
  • SENSITIVITY:敏感列等级调整
OrderResultType String AS_ADMIN

搜索类型,取值和说明如下:

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

时间搜索条件,取值:

  • CREATE_TIME: 创建时间
  • MODIFY_TIME: 修改时间
StartTime String 2019-10-10 00:00:00

开始时间。

EndTime String 2019-10-10 00:00:00

结束时间。

SearchContent String test

搜索内容。

OrderStatus String ALL

工单状态,取值和说明如下:

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

每页记录数。

PageNumber Integer 1

第几页。

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Orders Array of Order

工单列表信息。

Order
Comment String test

工单备注信息。

Committer String test

工单提交者。

CommitterId Long 1

工单提交者ID。

CreateTime String 2019-10-10 00:00:00

工单创建时间。

LastModifyTime String 2019-10-10 00:00:00

工单最后修改时间。

OrderId Long 1432

工单ID。

PluginType String DC_COMMON

工单类型。

StatusCode String success

工单状态码。

StatusDesc String success

工单状态描述。

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

请求ID。

Success Boolean true

请求是否成功。

TotalCount Long 100

记录总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListOrders
&<公共请求参数>

正常返回示例

XML 格式

<TotalCount>5</TotalCount>
<RequestId>7AC17A86-9E6F-484B-AE8D-F9416986A108</RequestId>
<Orders>
    <Order>
        <StatusCode>success</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[子账号]</Committer>
        <StatusDesc>数据变更成功</StatusDesc>
        <LastModifyTime>2019-11-19 13:53:05</LastModifyTime>
        <CreateTime>2019-11-19 13:52:36</CreateTime>
        <OrderId>737160</OrderId>
        <Comment>测试数据变更</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>new</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[子账号]</Committer>
        <StatusDesc>待提交审批</StatusDesc>
        <LastModifyTime>2019-10-29 20:51:37</LastModifyTime>
        <CreateTime>2019-10-29 20:51:36</CreateTime>
        <OrderId>737116</OrderId>
        <Comment>测试创建数据变更工单</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>closed</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[子账号]</Committer>
        <StatusDesc>工单已关闭:还是不支持库级别操作</StatusDesc>
        <LastModifyTime>2019-10-20 22:09:38</LastModifyTime>
        <CreateTime>2019-10-20 22:08:19</CreateTime>
        <OrderId>737089</OrderId>
        <Comment>测试建库</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>new</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[子账号]</Committer>
        <StatusDesc>预检查失败</StatusDesc>
        <LastModifyTime>2019-09-30 16:58:35</LastModifyTime>
        <CreateTime>2019-09-30 16:58:34</CreateTime>
        <OrderId>737016</OrderId>
        <Comment>测试</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>success</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[子账号]</Committer>
        <StatusDesc>数据变更成功</StatusDesc>
        <LastModifyTime>2019-08-17 14:07:54</LastModifyTime>
        <CreateTime>2019-08-17 14:07:42</CreateTime>
        <OrderId>736774</OrderId>
        <Comment>测试普通数据变更</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
</Orders>
<Success>true</Success>

JSON 格式

{
  "TotalCount": 5,
  "RequestId": "7AC17A86-9E6F-484B-AE8D-F9416986A108",
  "Orders": {
    "Order": [
      {
        "StatusCode": "success",
        "PluginType": "DC_COMMON",
        "Committer": "xxx[子账号]",
        "StatusDesc": "数据变更成功",
        "LastModifyTime": "2019-11-19 13:53:05",
        "CreateTime": "2019-11-19 13:52:36",
        "OrderId": 737160,
        "Comment": "测试数据变更",
        "CommitterId": 104442
      },
      {
        "StatusCode": "new",
        "PluginType": "DC_COMMON",
        "Committer": "xxx[子账号]",
        "StatusDesc": "待提交审批",
        "LastModifyTime": "2019-10-29 20:51:37",
        "CreateTime": "2019-10-29 20:51:36",
        "OrderId": 737116,
        "Comment": "测试创建数据变更工单",
        "CommitterId": 104442
      },
      {
        "StatusCode": "closed",
        "PluginType": "DC_COMMON",
        "Committer": "xxx[子账号]",
        "StatusDesc": "工单已关闭:还是不支持库级别操作",
        "LastModifyTime": "2019-10-20 22:09:38",
        "CreateTime": "2019-10-20 22:08:19",
        "OrderId": 737089,
        "Comment": "测试建库",
        "CommitterId": 104442
      },
      {
        "StatusCode": "new",
        "PluginType": "DC_COMMON",
        "Committer": "xxx[子账号]",
        "StatusDesc": "预检查失败",
        "LastModifyTime": "2019-09-30 16:58:35",
        "CreateTime": "2019-09-30 16:58:34",
        "OrderId": 737016,
        "Comment": "测试",
        "CommitterId": 104442
      },
      {
        "StatusCode": "success",
        "PluginType": "DC_COMMON",
        "Committer": "xxx[子账号]",
        "StatusDesc": "数据变更成功",
        "LastModifyTime": "2019-08-17 14:07:54",
        "CreateTime": "2019-08-17 14:07:42",
        "OrderId": 736774,
        "Comment": "测试普通数据变更",
        "CommitterId": 104442
      }
    ]
  },
  "Success": true
}

错误码

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