使用GetTaskStatus查詢非同步任務狀態-雲SSO-阿里雲

介面說明

本 API 主要是查詢非同步任務的狀態資訊，如需查詢非同步任務的更多資訊，請使用 GetTask 。

本文將提供一個樣本，查詢 ID 為t-shfqw1u1edszvxw5****的任務資訊。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cloudsso:GetTaskStatus

get

*Directory

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

無

請求參數

名稱	類型	必填	描述	樣本值
DirectoryId	string	是	目錄 ID。	d-00fc2p61****
TaskId	string	是	任務 ID。	t-shfqw1u1edszvxw5****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	任務狀態資訊。
Status	string	任務狀態。取值： InProgress：任務執行中。 Success：任務執行成功。 Failed：任務執行失敗。	Success
TaskId	string	任務 ID。	t-shfqw1u1edszvxw5****
EndTime	string	任務結束時間。	2021-11-05T02:58:08Z
TaskType	string	任務類型。取值： ProvisionAccessConfiguration：部署訪問配置。 DeprovisionAccessConfiguration：解除訪問配置部署。 CreateAccessAssignment：在 RD 帳號上授權。 DeleteAccessAssignment：移除 RD 帳號上的授權。	DeleteAccessAssignment
FailureReason	string	任務失敗原因。說明只有`Status`為`Failed`，才會顯示該參數。	No Permission.
StartTime	string	任務開始時間。	2021-11-05T02:58:07Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "005F4623-AE53-504D-830F-44825F7DC211",
  "TaskStatus": {
    "Status": "Success",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "EndTime": "2021-11-05T02:58:08Z",
    "TaskType": "DeleteAccessAssignment",
    "FailureReason": "No Permission.",
    "StartTime": "2021-11-05T02:58:07Z"
  }
}

錯誤碼

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

變更歷史

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