列表查询同步任务详情信息。
接口说明
支持以下两种方式查看返回数据:
-
方式一:分页查询首页时,仅需设置 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 | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
PageNumber | long | 否 | 列表页码,从 1 开始。 | 1 |
PageSize | long | 否 | 列表大小,最大值 100。 | 10 |
NextToken | string | 否 | 查询下一页凭证(Token),如果没有下一页时,该参数不再返回。 | NTxxxxxexample |
MaxResults | long | 否 | 分页查询时每页行数,最大值 100。 | 20 |
TargetType | string | 否 | 同步目标类型,取值可选范围:
| identity_provider |
TargetIds | array | 否 | 同步目标 ID 列表。[idp_111XXXX,idp_222XXXX] | |
string | 否 | 同步目标 ID | idp_my664lwkhpicbyzirog3xxxxx | |
StartTime | long | 否 | 同步开始时间,Unix 时间戳格式,单位为毫秒。 | 1649830226000 |
EndTime | long | 否 | 同步结束时间,Unix 时间戳格式,单位为毫秒。 | 1649830226000 |
Direction | string | 否 | 同步任务方向,取值可选范围:
| ingress |
Status | string | 否 | 同步任务状态,取值可选范围:
| running |
Filters | array<object> | 否 | 过滤参数 |
返回参数
示例
正常返回示例
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": 0,
"Success": 0,
"Failed": 0,
"Skipped": 0
}
},
"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"
},
"Description": "描述"
}
]
}
错误码
访问错误中心查看更多错误码。