GetSynchronizationJob - 查询单个同步任务信息

获取单个同步任务详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:GetSynchronizationJobget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
SynchronizationJobIdstring

同步任务 ID

sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

同步任务信息对象

SynchronizationJobIdstring

同步任务 ID

sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx
TargetTypestring

同步目标类型,取值可选范围:

  • identity_provider:身份提供方

  • application:应用

identity_provider
TargetIdstring

同步目标 ID

idp_my664lwkhpicbyzirog3nxxxxx
Directionstring

同步任务方向,取值可选范围:

  • ingress:入方向

  • egress:出方向

ingress
StartTimelong

同步开始时间,Unix 时间戳格式,单位为毫秒。

1649830226000
EndTimelong

同步结束时间,Unix 时间戳格式,单位为毫秒。

1649830226000
TriggerTypestring

同步触发类型,取值可选范围:

  • auto:自动触发

  • manual:手动触发

auto
Statusstring

同步任务状态,取值可选范围:

  • pending:初始状态

  • running:运行中

  • failed:失败

  • partial_success:部分成功

  • success:成功

running
Resultobject

同步任务结果

UserStatisticsobject

用户同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Updatedobject

更新结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Bindedobject

绑定结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Deletedobject

删除结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Sameobject

相同结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Pushedobject

推送结果统计

Totallong

总共数目

10
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
OrganizationalUnitStatisticsobject

组织同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Updatedobject

更新结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Bindedobject

绑定结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Deletedobject

删除结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Sameobject

相同结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Pushedobject

推送结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
GroupStatisticsobject

组同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Updatedobject

更新结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Bindedobject

绑定结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Deletedobject

删除结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Sameobject

相同结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Pushedobject

推送结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
GroupMemberStatisticsobject

组成员同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Updatedobject

更新结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Bindedobject

绑定结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Deletedobject

删除结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Sameobject

相同结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
Pushedobject

推送结果统计

Totallong

总共数目

30
Successlong

成功数目

10
Failedlong

失败数目

10
Skippedlong

跳过数目

10
ErrorMessagestring

同步结果错误信息描述

内部错误
ErrorCodestring

同步结果错误码

ErrorCodeNotFound

示例

正常返回示例

JSON格式

{
  "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": "内部错误",
      "ErrorCode": "ErrorCodeNotFound"
    }
  }
}

错误码

访问错误中心查看更多错误码。