全部產品
Search

搜尋本產品

    CloudSSO：ListTasks - 查詢非同步工作清單

    文件中心

    CloudSSO：ListTasks - 查詢非同步工作清單

    更新時間：Dec 20, 2025

    調用ListTasks查詢非同步工作清單。

    介面說明

    本 API 預設查詢距離目前時間 24 小時內的工作清單。最多支援查詢 7 天內的工作清單。您可以通過Filter參數設定查詢的開始時間。

    本文將提供一個樣本，查詢 24 小時內的工作清單。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cloudsso:ListTasks

    list

    *Directory

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DirectoryId

    string

    是

    目錄 ID。

    d-00fc2p61****
    AccessConfigurationId

    string

    否

    訪問配置 ID，用於查詢的過濾條件。

    ac-00jhtfl8thteu6uj****
    TargetType

    string

    否

    任務目標類型，用於查詢的過濾條件。

    取值：RD-Account，表示任務目標類型為 RD 帳號。

    說明

    TargetId與TargetType必須同時配置才能作為有效過濾條件進行查詢。

    RD-Account
    TargetId

    string

    否

    任務目標 ID，用於查詢的過濾條件。

    說明

    TargetId與TargetType必須同時配置才能作為有效過濾條件進行查詢。

    114240524784****
    PrincipalType

    string

    否

    雲 SSO 身份類型，用於查詢的過濾條件。取值：

    • User：使用者。

    • Group：使用者組。

    說明

    PrincipalId與PrincipalType必須同時配置才能作為有效過濾條件進行查詢。

    User
    PrincipalId

    string

    否

    雲 SSO 身份 ID，用於查詢的過濾條件。具體如下：

    • 當PrincipalType為User時，PrincipalId為雲 SSO 使用者識別碼。

    • 當PrincipalType為Group時，PrincipalId為雲 SSO 使用者組 ID。

    說明

    PrincipalId與PrincipalType必須同時配置才能作為有效過濾條件進行查詢。

    u-00q8wbq42wiltcrk****
    TaskType

    string

    否

    任務類型，用於查詢的過濾條件。取值：

    • ProvisionAccessConfiguration：部署訪問配置。

    • DeprovisionAccessConfiguration：解除訪問配置部署。

    • CreateAccessAssignment：在 RD 帳號上授權。

    • DeleteAccessAssignment：移除 RD 帳號上的授權。

    CreateAccessAssignment
    Status

    string

    否

    任務狀態，用於查詢的過濾條件。取值：

    • InProgress：任務執行中。

    • Success：任務執行成功。

    • Failed：任務執行失敗。

    Success
    NextToken

    string

    否

    查詢返回結果下一頁的令牌。首次調用 API 不需要NextToken。

    當您首次調用 API 時，如果返回資料總條數超過MaxResults限制，資料會被截斷，只返回MaxResults條資料，同時，返回參數IsTruncated為true，返回一個NextToken。您可以使用上一次返回的NextToken繼續調用 API，其他請求參數保持不變，查詢被截斷的資料。您可以按此方法多次查詢，直到IsTruncated為false，表示全部資料查詢完畢。

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    MaxResults

    integer

    否

    每頁的最巨量資料條數。

    取值範圍：1~20。

    預設值：10。

    10
    Filter

    string

    否

    過濾條件。

    格式： ，不區分大小寫。其中，只支援 StartTime，只支援 ge（Greater Than or Equals），格式為 YYYY-MM-DDTHH:mm:SSZ，且只能填寫距離目前時間不超過 7 天的值。

    樣本：Filter = "StartTime ge 2021-03-15T01:12:23Z"，表示查詢從 2021-03-15T01:12:23 GMT（0 時區）時間開始的工作清單。

    說明

    如不指定該參數，則預設返回距離目前時間 24 小時內的工作清單。

    StartTime ge 2021-03-15T01:12:23Z

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    Tasks

    array<object>

    工作清單。

    object

    工作清單。

    Status

    string

    任務狀態。取值：

    • InProgress：任務執行中。

    • Success：任務執行成功。

    • Failed：任務執行失敗。

    Success
    TaskId

    string

    任務 ID。

    t-sh5k4gesm6twlrqb****
    EndTime

    string

    任務結束時間。

    2021-11-09T05:50:50Z
    PrincipalId

    string

    雲 SSO 身份 ID。

    u-00q8wbq42wiltcrk****
    TargetPath

    string

    任務目標在資來源目錄中的路徑 ID。

    rd-3G****/r-Wm****/114240524784****
    StartTime

    string

    任務開始時間。

    2021-11-09T05:50:50Z
    PrincipalName

    string

    雲 SSO 身份名稱。

    Alice
    TargetName

    string

    任務目標名稱。

    dev-test
    TargetId

    string

    任務目標 ID。

    114240524784****
    AccessConfigurationName

    string

    訪問配置名稱。

    ECS-Admin
    TargetPathName

    string

    任務目標在資來源目錄中的路徑名稱。

    rd-3G****/root/dev-test
    TaskType

    string

    任務類型。取值：

    • ProvisionAccessConfiguration：部署訪問配置。

    • DeprovisionAccessConfiguration：解除訪問配置部署。

    • CreateAccessAssignment：在 RD 帳號上授權。

    • DeleteAccessAssignment：移除 RD 帳號上的授權。

    CreateAccessAssignment
    FailureReason

    string

    任務失敗原因。

    說明

    只有Status為Failed，才顯示該參數。

    No Permission.
    TargetType

    string

    任務目標類型。

    取值：RD-Account，表示任務目標類型為 RD 帳號。

    RD-Account
    AccessConfigurationId

    string

    訪問配置 ID。

    ac-00jhtfl8thteu6uj****
    PrincipalType

    string

    雲 SSO 身份類型。取值：

    • User：使用者。

    • Group：使用者組。

    User
    NextToken

    string

    查詢返回結果下一頁的令牌。

    說明

    只有IsTruncated為true，才顯示該參數。

    K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    RequestId

    string

    請求 ID。

    C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
    MaxResults

    integer

    每頁的最巨量資料條數。

    10
    TotalCounts

    integer

    符合請求參數條件的資料總條數。

    1
    IsTruncated

    boolean

    返回結果是否被截斷。取值：

    • true：已截斷。

    • false：未截斷。

    false

    樣本

    正常返回樣本

    JSON格式

    {
  "Tasks": [
    {
      "Status": "Success",
      "TaskId": "t-sh5k4gesm6twlrqb****",
      "EndTime": "2021-11-09T05:50:50Z",
      "PrincipalId": "u-00q8wbq42wiltcrk****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "StartTime": "2021-11-09T05:50:50Z",
      "PrincipalName": "Alice",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "CreateAccessAssignment",
      "FailureReason": "No Permission.",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
      "PrincipalType": "User"
    }
  ],
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3",
  "MaxResults": 10,
  "TotalCounts": 1,
  "IsTruncated": false
}

    錯誤碼

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

    變更歷史

    更多資訊，參考變更詳情。