Query Sync Jobs via ListSynchronizationJobs API with NextToken - EIAM - Alibaba Cloud - Identity as a Service

Query the list of synchronization job details.

Operation description

The following two methods are supported for viewing returned data:

Method 1: When querying the first page, you only need to set MaxResults to limit the number of entries returned. The NextToken in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the NextToken parameter to the NextToken value obtained from the previous response as the query credential, and set MaxResults to limit the number of entries returned. If there are no more pages, NextToken is no longer returned. The maximum value of MaxResults is 100.
Method 2: Set the number of entries returned per page using PageSize, and set the page number using PageNumber.

You can only choose one of the above two methods. When a large number of entries are returned, Method 1 is recommended. If the MaxResults or NextToken parameter is set, the PageSize and PageNumber request parameters become invalid.

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	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	Page number, starting from 1.	1
PageSize	integer	No	Page size. Maximum value: 100.	10
NextToken	string	No	Token for querying the next page. This parameter is not returned when there are no more pages.	NTxxxxxexample
MaxResults	integer	No	Number of rows per page for paginated queries. Maximum value: 100.	20
TargetType	string	No	Synchronization target type. Valid values: identity_provider: identity provider application: application	identity_provider
TargetIds	array	No	List of synchronization target IDs. [idp_111XXXX,idp_222XXXX]	target_001
	string	No	Synchronization target ID	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	No	Synchronization start time in Unix timestamp format, in milliseconds.	1649830226000
EndTime	integer	No	Synchronization end time in Unix timestamp format, in milliseconds.	1649830226000
Direction	string	No	Synchronization job direction. Valid values: ingress: inbound egress: outbound	ingress
Status	string	No	Synchronization job status. Valid values: pending: initial state running: running failed: failed partial_success: partially succeeded success: succeeded	running
Filters	array<object>	No	Filter parameters
	object	No	Filter parameters
Key	string	No	Dynamic parameter name	qps
Values	array	No	Dynamic parameter values
	string	No	Dynamic parameter values	[]

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	Total number of entries.	100
NextToken	string	The query token value returned by this request.	NTxxxexample
SynchronizationJobs	array<object>	List of synchronization jobs
	array<object>	Synchronization job details.
SynchronizationJobId	string	Synchronization job ID	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	Synchronization target type. Valid values: identity_provider: identity provider application: application	identity_provider
TargetId	string	Synchronization target ID	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	Synchronization job direction. Valid values: ingress: inbound egress: outbound	ingress
StartTime	integer	Synchronization start time in Unix timestamp format, in milliseconds.	1649830226000
EndTime	integer	Synchronization end time in Unix timestamp format, in milliseconds.	1649830226000
TriggerType	string	Synchronization trigger type. Valid values: auto: automatically triggered manual: manually triggered	auto
Status	string	Synchronization job status. Valid values: pending: initial state running: running failed: failed partial_success: partially succeeded success: succeeded	success
Result	object	Synchronization job result
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	Synchronization job description	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.