ListSynchronizationJobs - 列表查询同步任务信息_应用身份服务 (IDaaS)(IDaaS)-阿里云帮助中心

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

接口说明

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

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eiam:ListSynchronizationJobs

list

*SynchronizationJob

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

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	否	列表页码，从 1 开始。	1
PageSize	integer	否	列表大小，最大值 100。	10
NextToken	string	否	查询下一页凭证（Token），如果没有下一页时，该参数不再返回。	NTxxxxxexample
MaxResults	integer	否	分页查询时每页行数，最大值 100。	20
TargetType	string	否	同步目标类型，取值可选范围： identity_provider：身份提供方 application：应用	identity_provider
TargetIds	array	否	同步目标 ID 列表。[idp_111XXXX,idp_222XXXX]	target_001
	string	否	同步目标 ID	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	否	同步开始时间，Unix 时间戳格式，单位为毫秒。	1649830226000
EndTime	integer	否	同步结束时间，Unix 时间戳格式，单位为毫秒。	1649830226000
Direction	string	否	同步任务方向，取值可选范围： ingress：入方向 egress：出方向	ingress
Status	string	否	同步任务状态，取值可选范围： pending：初始状态 running：运行中 failed：失败 partial_success：部分成功 success：成功	running
Filters	array<object>	否	过滤参数
	object	否	过滤参数
Key	string	否	动态参数名称	qps
Values	array	否	动态参数值
	string	否	动态参数值	[]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	列表总条数目。	100
NextToken	string	本次调用返回的查询凭证（Token）值。	NTxxxexample
SynchronizationJobs	array<object>	同步任务信息列表
	object	同步任务详情。
SynchronizationJobId	string	同步任务 ID	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	同步目标类型，取值可选范围： identity_provider：身份提供方 application：应用	identity_provider
TargetId	string	同步目标 ID	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	同步任务方向，取值可选范围： ingress：入方向 egress：出方向	ingress
StartTime	integer	同步开始时间，Unix 时间戳格式，单位为毫秒。	1649830226000
EndTime	integer	同步结束时间，Unix 时间戳格式，单位为毫秒。	1649830226000
TriggerType	string	同步触发类型，取值可选范围： auto：自动触发 manual：手动触发	auto
Status	string	同步任务状态，取值可选范围： pending：初始状态 running：运行中 failed：失败 partial_success：部分成功 success：成功	success
Result	object	同步任务结果
UserStatistics	object	用户同步结果统计
Created	object	创建结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Updated	object	更新结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Binded	object	绑定结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Deleted	object	删除结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Same	object	相同结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Pushed	object	推送结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Exported	object	导出结果统计
Total	integer	总共数目	5
Success	integer	成功数目	2
Failed	integer	失败数目	2
Skipped	integer	跳过数目	1
OrganizationalUnitStatistics	object	组织同步结果统计
Created	object	创建结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Updated	object	更新结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Binded	object	绑定结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Deleted	object	删除结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Same	object	相同结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Pushed	object	推送结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
GroupStatistics	object	组同步结果统计
Created	object	创建结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Updated	object	更新结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Binded	object	绑定结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Deleted	object	删除结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Same	object	相同结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Pushed	object	推送结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
GroupMemberStatistics	object	组成员同步结果统计
Created	object	创建结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Updated	object	更新结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Binded	object	绑定结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Deleted	object	删除结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Same	object	相同结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
Pushed	object	推送结果统计
Total	integer	总共数目	3
Success	integer	成功数目	1
Failed	integer	失败数目	1
Skipped	integer	跳过数目	1
ErrorMessage	string	同步结果错误信息描述	The specified parameter Username is required!
ErrorCode	string	同步结果错误码	MissingParameter.Username
Description	string	同步任务描述	Description

示例

正常返回示例

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
          },
          "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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。