All Products
Search
Document Center

Identity as a Service:GetSynchronizationJob

Last Updated:Jul 25, 2025

Obtains the information about a single synchronization job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eiam:GetSynchronizationJobget
*SynchronizationJob
acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx
SynchronizationJobIdstringYes

The ID of the synchronization job.

sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJobobject

The information about the synchronization job.

SynchronizationJobIdstring

The ID of the synchronization job.

sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx
TargetTypestring

The type of the synchronization destination. Valid values:

  • identity_provider
  • application
identity_provider
TargetIdstring

The ID of the synchronization destination.

idp_my664lwkhpicbyzirog3nxxxxx
Directionstring

The direction of the synchronization job. Valid values:

  • ingress
  • egress
ingress
StartTimelong

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
EndTimelong

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
TriggerTypestring

The trigger type of the synchronization. Valid values:

  • auto
  • manual
auto
Statusstring

The status of the synchronization job. Valid values:

  • pending
  • running
  • failed
  • partial_success
  • success
running
Resultobject

The result of the synchronization job.

UserStatisticsobject

The user synchronization result statistics.

Createdobject

The creation result statistics.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Updatedobject

The update result statistics.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Bindedobject

The binding result statistics.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Deletedobject

The deletion result statistics.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Sameobject

The result statistics about identical users.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Pushedobject

The notification result statistics.

Totallong

The total number of items.

10
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
OrganizationalUnitStatisticsobject

The organization synchronization result statistics.

Createdobject

The creation result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Updatedobject

The update result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Bindedobject

The binding result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Deletedobject

The deletion result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Sameobject

The result statistics about identical organizations.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Pushedobject

The notification result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
GroupStatisticsobject

The group synchronization result statistics.

Createdobject

The creation result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Updatedobject

The update result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Bindedobject

The binding result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Deletedobject

The deletion result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Sameobject

The result statistics about identical groups.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Pushedobject

The notification result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
GroupMemberStatisticsobject

The group member synchronization result statistics.

Createdobject

The creation result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Updatedobject

The update result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Bindedobject

The binding result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Deletedobject

The deletion result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Sameobject

The result statistics about identical group members.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
Pushedobject

The notification result statistics.

Totallong

The total number of items.

30
Successlong

The number of successful items.

10
Failedlong

The number of failed items.

10
Skippedlong

The number of skipped items.

10
ErrorMessagestring

The error message returned in the case of an error.

The specified SynchronizationJob resource: %s not found.
ErrorCodestring

The error code corresponding to the error message.

ResourceNotFound. SynchronizationJob

Examples

Sample success responses

JSONformat

{
  "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": "The specified SynchronizationJob resource: %s not found. ",
      "ErrorCode": "ResourceNotFound. SynchronizationJob"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.