全部產品
Search
文件中心

Data Management:ListOrders - 擷取工單列表資訊

更新時間:Feb 10, 2026

調用ListOrders擷取工單列表資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListOrders

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

租戶 ID,可通過調用介面 GetUserActiveTenantListUserTenants 擷取該參數的值。

3***

PluginType

string

工單類型,取值請參見 PluginType 參數說明

DC_COMMON

OrderResultType

string

搜尋類型。若您不填寫此參數,則預設擷取您發起的工單(AS_COMMITTER)資訊。取值及說明如下:

  • AS_ADMIN:工單大盤(需要角色是管理員)

  • AS_COMMITTER:我發起的工單

  • AS_HANDLER:待我處理的工單

  • AS_OWNER:我已處理的工單

  • AS_Related:與我相關

說明
  • 建議設定為 AS_ADMIN

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

object

Order

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

integer

工單提交者的使用者識別碼。

51****

StatusDesc

string

工單狀態原因。

變更成功

PluginType

string

工單類型。

DC_COMMON

OrderId

integer

工單 ID。

51****

TotalCount

integer

記錄總數。

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情