GetSynchronizationJob API Reference - Identity as a Service

Obtains the information about a single synchronization job.

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

get

*SynchronizationJob

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
SynchronizationJobId	string	Yes	The ID of the synchronization job.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJob	object	The information about the synchronization job.
SynchronizationJobId	string	The ID of the synchronization job.	sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx
TargetType	string	The type of the synchronization destination. Valid values: identity_provider application	identity_provider
TargetId	string	The ID of the synchronization destination.	idp_my664lwkhpicbyzirog3nxxxxx
Direction	string	The direction of the synchronization job. Valid values: ingress egress	ingress
StartTime	integer	The start time of the synchronization. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1649830226000
EndTime	integer	The end time of the synchronization. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1649830226000
TriggerType	string	The trigger type of the synchronization. Valid values: auto manual	auto
Status	string	The status of the synchronization job. Valid values: pending running failed partial_success success	running
Result	object	The result of the synchronization job.
UserStatistics	object	The user synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical users.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
OrganizationalUnitStatistics	object	The organization synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical organizations.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
GroupStatistics	object	The group synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical groups.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
GroupMemberStatistics	object	The group member synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical group members.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
ErrorMessage	string	The error message returned in the case of an error.	Internal error
ErrorCode	string	The error code corresponding to the error message.	ErrorCodeNotFound

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "SynchronizationJob": {
    "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\n",
    "TargetType": "identity_provider",
    "TargetId": "idp_my664lwkhpicbyzirog3nxxxxx\n",
    "Direction": "ingress",
    "StartTime": 1649830226000,
    "EndTime": 1649830226000,
    "TriggerType": "auto",
    "Status": "running",
    "Result": {
      "UserStatistics": {
        "Created": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "OrganizationalUnitStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "GroupStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "GroupMemberStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "ErrorMessage": "Internal error",
      "ErrorCode": "ErrorCodeNotFound"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.