ListTasks API Reference for Asynchronous Task Queries - CloudSSO - Alibaba Cloud - CloudSSO

Queries asynchronous tasks.

Operation description

By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using Filter.

This topic provides an example on how to query the tasks within the previous 24 hours.

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:ListTasks

list

*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****
AccessConfigurationId	string	No	The ID of the access configuration. The ID can be used to filter access permissions.	ac-00jhtfl8thteu6uj****
TargetType	string	No	The type of the task object. The type can be used to filter access permissions. Set the value to RD-Account, which specifies the accounts in the resource directory. Note You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.	RD-Account
TargetId	string	No	The ID of the task object. The ID can be used to filter access permissions. Note You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.	114240524784****
PrincipalType	string	No	The type of the CloudSSO identity. The type can be used to filter access permissions. Valid values: User Group Note You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.	User
PrincipalId	string	No	The ID of the CloudSSO identity. The ID can be used to filter access permissions. If you set `PrincipalType` to `User`, set `PrincipalId` to the ID of the CloudSSO user. If you set `PrincipalType` to `Group`, set `PrincipalId` to the ID of the CloudSSO group. Note You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.	u-00q8wbq42wiltcrk****
TaskType	string	No	The type of the task. The type can be used to filter tasks. 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.	CreateAccessAssignment
Status	string	No	The ID of the task. The ID can be used to filter tasks. Valid values: InProgress: The task is running. Success: The task is successful. Failed: The task failed.	Success
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter. When you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 20. Default value: 10.	10
Filter	string	No	The filter condition. The condition is not case-sensitive. The condition must be in the StartTime ge YYYY-MM-DDTHH:mm:SSZ format. You must set YYYY-MM-DDTHH:mm:SSZ to a value that is no more than 7 days from the current time. ge indicates Greater Than or Equals. For example, if you set the Filter parameter to StartTime ge 2021-03-15T01:12:23Z, the operation queries the tasks from 2021-03-15T01:12:23 GMT. Note If you do not specify this parameter, the operation queries the tasks within the previous 24 hours by default.	StartTime ge 2021-03-15T01:12:23Z

Response elements

Element	Type	Description	Example
	object	The returned results.
Tasks	array<object>	The tasks.
	object
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 job.	t-sh5k4gesm6twlrqb****
EndTime	string	The end time of the task.	2021-11-09T05:50:50Z
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-09T05:50:50Z
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 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.	CreateAccessAssignment
FailureReason	string	The cause of the task failure. 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
NextToken	string	The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Note This parameter is returned only when the value of `IsTruncated` is `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
MaxResults	integer	The maximum number of entries returned per page.	10
TotalCounts	integer	The total number of entries returned.	1
IsTruncated	boolean	Indicates whether the queried entries are truncated. Valid values: true false	false

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.