Track Asynchronous Task Status via GetTaskStatus - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

Queries the status of an asynchronous task. To query more details about a task, call the GetTask operation.

The following example queries the task whose ID is t-shfqw1u1edszvxw5****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetTaskStatus

get

*Directory

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The returned results.
RequestId	string	The request ID.	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	The task status details.
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 ID of the task.	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.