CloudSSO:GetTask - CloudSSO - Alibaba Cloud - CloudSSO - Alibaba Cloud Documentation Center

Queries the information about an asynchronous task.

Operation description

This topic provides an example on how to query the information about a 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:GetTask

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.
Task	object	The task information.
Status	string	The status of the task. 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
PrincipalId	string	The ID of the CloudSSO identity.	u-00q8wbq42wiltcrk****
TargetPath	string	The path ID of the task object in the resource directory.	rd-3G**/r-Wm/114240524784**
StartTime	string	The start time of the task.	2021-11-05T02:58:07Z
PrincipalName	string	The name of the CloudSSO identity.	Alice
TargetName	string	The name of the task object.	dev-test
TargetId	string	The ID of the task object.	114240524784****
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
TargetPathName	string	The path name of the task object in the resource directory.	rd-3G****/root/dev-test
TaskType	string	The type of the task. 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 reason why the task failed. Note This parameter is returned only when the value of `Status` is `Failed`.	No Permission.
TargetType	string	The type of the task object. The value is fixed as RD-Account, which indicates the accounts in the resource directory.	RD-Account
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
PrincipalType	string	The type of the CloudSSO identity. Valid values: User Group	User
RequestId	string	The request ID.	923CA5E8-57BF-5E15-8BA6-E75A966B7E3F

Examples

Success response

JSON format

{
  "Task": {
    "Status": "Success",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "EndTime": "2021-11-05T02:58:08Z",
    "PrincipalId": "u-00q8wbq42wiltcrk****",
    "TargetPath": "rd-3G****/r-Wm****/114240524784****",
    "StartTime": "2021-11-05T02:58:07Z",
    "PrincipalName": "Alice",
    "TargetName": "dev-test",
    "TargetId": "114240524784****",
    "AccessConfigurationName": "ECS-Admin",
    "TargetPathName": "rd-3G****/root/dev-test",
    "TaskType": "DeleteAccessAssignment",
    "FailureReason": "No Permission.",
    "TargetType": "RD-Account",
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
    "PrincipalType": "User"
  },
  "RequestId": "923CA5E8-57BF-5E15-8BA6-E75A966B7E3F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.