GetTaskStatus - CloudSSO - Alibaba Cloud Documentation Center

Queries the status of an asynchronous task.

Operation description

You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the GetTask operation.

This topic provides an example on how to query the information about the task whose ID is t-shfqw1u1edszvxw5****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:GetTaskStatus	Read	Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The directory ID.	d-00fc2p61****
TaskId	string	Yes	The task ID.	t-shfqw1u1edszvxw5****

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
RequestId	string	The request ID.	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	The status information about the task.
Status	string	The task status. Valid values: InProgress: The task is running. Success: The task is successful. Failed: The task failed.	Success
TaskId	string	The task ID.	t-shfqw1u1edszvxw5****
EndTime	string	The end time of the task.	2021-11-05T02:58:08Z
TaskType	string	The task type. Valid values: ProvisionAccessConfiguration: An access configuration is provisioned. DeprovisionAccessConfiguration: An access configuration is de-provisioned. CreateAccessAssignment: Access permissions on an account in the resource directory are assigned. DeleteAccessAssignment: Access permissions on an account in the resource directory are removed.	DeleteAccessAssignment
FailureReason	string	The cause of the task failure. Note This parameter is returned only when the value of `Status` is `Failed`.	No Permission.
StartTime	string	The start time of the task.	2021-11-05T02:58:07Z

Examples

Sample success responses

JSONformat

{
  "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.