調用ListTasks查詢異步任務列表。
接口說明
本 API 默認查詢距離當前時間 24 小時內的任務列表。最多支持查詢 7 天內的任務列表。您可以通過Filter
參數設置查詢的開始時間。
本文將提供一個示例,查詢 24 小時內的任務列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cloudsso:ListTasks | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 身份類型,用于查詢的過濾條件。取值:
說明
PrincipalId 與PrincipalType 必須同時配置才能作為有效的過濾條件進行查詢。
| User |
PrincipalId | string | 否 | 云 SSO 身份 ID,用于查詢的過濾條件。具體如下:
說明
PrincipalId 與PrincipalType 必須同時配置才能作為有效的過濾條件進行查詢。
| u-00q8wbq42wiltcrk**** |
TaskType | string | 否 | 任務類型,用于查詢的過濾條件。取值:
| CreateAccessAssignment |
Status | string | 否 | 任務狀態,用于查詢的過濾條件。取值:
| Success |
NextToken | string | 否 | 查詢返回結果下一頁的令牌。首次調用 API 不需要 當您首次調用 API 時,如果返回數據總條數超過 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
MaxResults | integer | 否 | 每頁的最大數據條數。 取值范圍:1~20。 默認值:10。 | 10 |
Filter | string | 否 | 過濾條件。 格式: 示例:Filter = "StartTime ge 2021-03-15T01:12:23Z",表示查詢從 2021-03-15T01:12:23 GMT(0 時區)時間開始的任務列表。 說明
如不指定該參數,則默認返回距離當前時間 24 小時內的任務列表。
| StartTime ge 2021-03-15T01:12:23Z |
返回參數
示例
正常返回示例
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|