文档

ListOrders - 获取工单列表信息

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListOrdersList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenantListUserTenants 获取该参数的值。

3***
PluginTypestring

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

DC_COMMON
OrderResultTypestring

搜索类型。若您不填写此参数,则默认获取您发起的工单(AS_COMMITTER)信息。取值及说明如下:

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

时间搜索条件,取值如下:

  • CREATE_TIME: 创建时间
  • MODIFY_TIME: 修改时间
CREATE_TIME
StartTimestring

开始时间。

2022-04-08 11:00:00
EndTimestring

结束时间。

2022-04-09 11:00:00
SearchContentstring

搜索内容。

test
OrderStatusstring

工单状态,取值如下:

  • ALL:不限
  • FINISHED:已结束
  • RUNNING:进行中
ALL
PageSizeinteger

每页数据量。

10
PageNumberinteger

开始页码。

1

返回参数

名称类型描述示例值
object
Ordersobject []

工单列表信息。

Commentstring

工单备注信息。

test
LastModifyTimestring

工单最后修改时间。

2022-04-08 11:27:45
StatusCodestring

工单状态码,返回值如下:

  • fail:执行失败
  • toaudit:等待审批
  • cancel:用户撤销工单
  • processing:执行中
  • approved:审批完成
  • reject:审批撤销
  • success:执行成功
  • closed:工单关闭
success
CreateTimestring

工单创建时间。

2022-04-08 11:15:46
Committerstring

工单提交者。

test
CommitterIdlong

工单提交者的用户 ID。

51****
StatusDescstring

工单状态描述。

变更成功
PluginTypestring

工单类型。

DC_COMMON
OrderIdlong

工单 ID。

51****
TotalCountlong

记录总数。

1
RequestIdstring

请求 ID。

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

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • 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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈