ListSynchronizationJobs - Identity as a Service - Alibaba Cloud Documentation Center

Lists the details of synchronization tasks.

Operation description

You can view the returned data in one of the following two ways:

Method 1: To query the first page, set MaxResults to limit the number of entries to return. The NextToken value in the response is the token for the next page. To query subsequent pages, set NextToken to the value from the previous response and set MaxResults. If no more data is available, NextToken is not returned. The maximum value for MaxResults is 100.
Method 2: Set PageSize to specify the number of entries per page and PageNumber to specify the page number.

You can use only one of these methods. Method 1 is recommended when many entries are returned. If you set MaxResults or NextToken, the PageSize and PageNumber parameters are ignored.

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

eiam:ListSynchronizationJobs

list

*SynchronizationJob

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	The page number. The value starts from 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 100.	10
NextToken	string	No	The token to retrieve the next page of results. If no more pages exist, this parameter is not returned.	NTxxxxxexample
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100.	20
TargetType	string	No	The type of the synchronization target. Valid values: identity_provider: Identity provider. application: Application.	identity_provider
TargetIds	array	No	A list of synchronization target IDs. For example, `[idp_111XXXX,idp_222XXXX]`.	target_001
	string	No	The synchronization target ID.	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	No	The synchronization start time. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
EndTime	integer	No	The synchronization end time. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
Direction	string	No	The direction of the sync task. Valid values: ingress: Inbound. egress: Outbound.	ingress
Status	string	No	The status of the sync task. Valid values: pending: The task is pending. running: The task is running. failed: The task failed. partial_success: The task is partially successful. success: The task is successful.	running
Filters	array<object>	No	The filter parameters.
	object	No	A filter parameter.
Key	string	No	The name of the dynamic parameter.	qps
Values	array	No	The values of the dynamic parameter.
	string	No	A value of the dynamic parameter.	[]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
NextToken	string	The token to retrieve the next page of results.	NTxxxexample
SynchronizationJobs	array<object>	A list of sync task information.
	object	The details of a sync task.
SynchronizationJobId	string	The sync task ID.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	The type of the synchronization target. Valid values: identity_provider: Identity provider. application: Application.	identity_provider
TargetId	string	The synchronization target ID.	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	The direction of the sync task. Valid values: ingress: Inbound. egress: Outbound.	ingress
StartTime	integer	The synchronization start time. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
EndTime	integer	The synchronization end time. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
TriggerType	string	The trigger type of the synchronization. Valid values: auto: Automatic. manual: Manual.	auto
Status	string	The status of the sync task. Valid values: pending: The task is pending. running: The task is running. failed: The task failed. partial_success: The task is partially successful. success: The task is successful.	success
Result	object	The result of the sync task.
UserStatistics	object	The statistics of user synchronization results.
Created	object	The statistics of creation results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Updated	object	The statistics of update results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Binded	object	The statistics of binding results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Deleted	object	The statistics of deletion results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Same	object	The statistics of identical entries.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Pushed	object	The statistics of push results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Exported	object	The statistics of export results.
Total	integer	The total number.	5
Success	integer	The number of successful operations.	2
Failed	integer	The number of failed operations.	2
Skipped	integer	The number of skipped operations.	1
OrganizationalUnitStatistics	object	The statistics of organization synchronization results.
Created	object	The statistics of creation results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Updated	object	The statistics of update results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Binded	object	The statistics of binding results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Deleted	object	The statistics of deletion results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Same	object	The statistics of identical entries.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Pushed	object	The statistics of push results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
GroupStatistics	object	The statistics of group synchronization results.
Created	object	The statistics of creation results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Updated	object	The statistics of update results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Binded	object	The statistics of binding results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Deleted	object	The statistics of deletion results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Same	object	The statistics of identical entries.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Pushed	object	The statistics of push results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
GroupMemberStatistics	object	The statistics of group member synchronization results.
Created	object	The statistics of creation results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Updated	object	The statistics of update results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Binded	object	The statistics of binding results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Deleted	object	The statistics of deletion results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Same	object	The statistics of identical entries.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
Pushed	object	The statistics of push results.
Total	integer	The total number.	3
Success	integer	The number of successful operations.	1
Failed	integer	The number of failed operations.	1
Skipped	integer	The number of skipped operations.	1
ErrorMessage	string	The error message for the synchronization result.	The specified parameter Username is required!
ErrorCode	string	The error code for the synchronization result.	MissingParameter.Username
Description	string	The description of the sync task.	Description

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "SynchronizationJobs": [
    {
      "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx\n",
      "TargetType": "identity_provider",
      "TargetId": "idp_my664lwkhpicbyzirog3xxxxx\n",
      "Direction": "ingress",
      "StartTime": 1649830226000,
      "EndTime": 1649830226000,
      "TriggerType": "auto",
      "Status": "success",
      "Result": {
        "UserStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Exported": {
            "Total": 5,
            "Success": 2,
            "Failed": 2,
            "Skipped": 1
          }
        },
        "OrganizationalUnitStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupMemberStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "ErrorMessage": "The specified parameter Username is required!",
        "ErrorCode": "MissingParameter.Username"
      },
      "Description": " Description"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.