調(diào)用ListTasks查詢異步任務(wù)列表。
接口說明
本 API 默認(rèn)查詢距離當(dāng)前時(shí)間 24 小時(shí)內(nèi)的任務(wù)列表。最多支持查詢 7 天內(nèi)的任務(wù)列表。您可以通過Filter參數(shù)設(shè)置查詢的開始時(shí)間。
本文將提供一個(gè)示例，查詢 24 小時(shí)內(nèi)的任務(wù)列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cloudsso:ListTasks | list | *Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId} |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DirectoryId | string | 是 | 目錄 ID。 | d-00fc2p61**** |
| AccessConfigurationId | string | 否 | 訪問配置 ID，用于查詢的過濾條件。 | ac-00jhtfl8thteu6uj**** |
| TargetType | string | 否 | 任務(wù)目標(biāo)類型，用于查詢的過濾條件。 取值：RD-Account，表示任務(wù)目標(biāo)類型為 RD 賬號(hào)。 說明
TargetId與TargetType必須同時(shí)配置才能作為有效的過濾條件進(jìn)行查詢。
| RD-Account |
| TargetId | string | 否 | 任務(wù)目標(biāo) ID，用于查詢的過濾條件。 說明
TargetId與TargetType必須同時(shí)配置才能作為有效的過濾條件進(jìn)行查詢。
| 114240524784**** |
| PrincipalType | string | 否 | 云 SSO 身份類型，用于查詢的過濾條件。取值：
說明
PrincipalId與PrincipalType必須同時(shí)配置才能作為有效的過濾條件進(jìn)行查詢。
| User |
| PrincipalId | string | 否 | 云 SSO 身份 ID，用于查詢的過濾條件。具體如下：
說明
PrincipalId與PrincipalType必須同時(shí)配置才能作為有效的過濾條件進(jìn)行查詢。
| u-00q8wbq42wiltcrk**** |
| TaskType | string | 否 | 任務(wù)類型，用于查詢的過濾條件。取值：
| CreateAccessAssignment |
| Status | string | 否 | 任務(wù)狀態(tài)，用于查詢的過濾條件。取值：
| Success |
| NextToken | string | 否 | 查詢返回結(jié)果下一頁的令牌。首次調(diào)用 API 不需要 當(dāng)您首次調(diào)用 API 時(shí)，如果返回?cái)?shù)據(jù)總條數(shù)超過 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
| MaxResults | integer | 否 | 每頁的最大數(shù)據(jù)條數(shù)。 取值范圍：1~20。 默認(rèn)值：10。 | 10 |
| Filter | string | 否 | 過濾條件。 格式： 示例：Filter = "StartTime ge 2021-03-15T01:12:23Z"，表示查詢從 2021-03-15T01:12:23 GMT（0 時(shí)區(qū)）時(shí)間開始的任務(wù)列表。 說明
如不指定該參數(shù)，則默認(rèn)返回距離當(dāng)前時(shí)間 24 小時(shí)內(nèi)的任務(wù)列表。
| StartTime ge 2021-03-15T01:12:23Z |
返回參數(shù)
示例
正常返回示例
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
}錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|