ListSynchronizationJobs - 列表查询同步任务信息

列表查询同步任务详情信息。

接口说明

支持以下两种方式查看返回数据:

  • 方式一:分页查询首页时,仅需设置 MaxResults 以限制返回信息的条目数,返回结果中的 NextToken 将作为查询后续页的凭证。查询后续页时,将 NextToken 参数设置为上一次返回结果中获取到的 NextToken 作为查询凭证,并设置 MaxResults 限制返回条目数。如果没有下一页时,NextToken 不再返回。MaxResults 最大值为 100。

  • 方式二:通过 PageSize 设置单页返回的条目数,再通过 PageNumber 设置页码。

以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了 MaxResults 或 NextToken 参数,则请求参数 PageSize 和 PageNumber 将失效。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumberlong

列表页码,从 1 开始。

1
PageSizelong

列表大小,最大值 100。

10
NextTokenstring

查询下一页凭证(Token),如果没有下一页时,该参数不再返回。

NTxxxxxexample
MaxResultslong

分页查询时每页行数,最大值 100。

20
TargetTypestring

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

  • identity_provider:身份提供方

  • application:应用

identity_provider
TargetIdsarray

同步目标 ID 列表。[idp_111XXXX,idp_222XXXX]

string

同步目标 ID

idp_my664lwkhpicbyzirog3xxxxx
StartTimelong

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

1649830226000
EndTimelong

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

1649830226000
Directionstring

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

  • ingress:入方向

  • egress:出方向

ingress
Statusstring

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

  • pending:初始状态

  • running:运行中

  • failed:失败

  • partial_success:部分成功

  • success:成功

running

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

列表总条数目。

100
NextTokenstring

本次调用返回的查询凭证(Token)值。

NTxxxexample
SynchronizationJobsarray<object>

同步任务信息列表

object
SynchronizationJobIdstring

同步任务 ID

sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetTypestring

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

  • identity_provider:身份提供方

  • application:应用

identity_provider
TargetIdstring

同步目标 ID

idp_my664lwkhpicbyzirog3xxxxx
Directionstring

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

  • ingress:入方向

  • egress:出方向

ingress
StartTimelong

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

1649830226000
EndTimelong

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

1649830226000
TriggerTypestring

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

  • auto:自动触发

  • manual:手动触发

auto
Statusstring

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

  • pending:初始状态

  • running:运行中

  • failed:失败

  • partial_success:部分成功

  • success:成功

success
Resultobject

同步任务结果

UserStatisticsobject

用户同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Updatedobject

更新结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Bindedobject

绑定结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Deletedobject

删除结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Sameobject

相同结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Pushedobject

推送结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
OrganizationalUnitStatisticsobject

组织同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Updatedobject

更新结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Bindedobject

绑定结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Deletedobject

删除结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Sameobject

相同结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Pushedobject

推送结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
GroupStatisticsobject

组同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Updatedobject

更新结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Bindedobject

绑定结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Deletedobject

删除结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Sameobject

相同结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Pushedobject

推送结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
GroupMemberStatisticsobject

组成员同步结果统计

Createdobject

创建结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Updatedobject

更新结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Bindedobject

绑定结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Deletedobject

删除结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Sameobject

相同结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
Pushedobject

推送结果统计

Totallong

总共数目

3
Successlong

成功数目

1
Failedlong

失败数目

1
Skippedlong

跳过数目

1
ErrorMessagestring

同步结果错误信息描述

内部错误
ErrorCodestring

同步结果错误码

ErrorCodeNotFound

示例

正常返回示例

JSON格式

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

错误码

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