文档

ListUserProvisioningEvents - 查询RAM用户同步事件列表

更新时间:
一键部署

调用ListUserProvisioningEvents查询RAM用户同步事件列表。

调试

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

授权信息

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

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

请求参数

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

RAM 用户同步的 ID。

up-002axzhapcbz6e63****
DirectoryIdstring

目录 ID。

d-00xz91nf****
MaxResultsinteger

每页的最大数据条数。

取值范围:1~100。

默认值:10。

10
NextTokenstring

查询返回结果下一页的令牌。首次调用 API 不需要NextToken

当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncatedtrue,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncatedfalse,表示全部数据查询完毕。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

查询返回结果下一页的令牌。

说明 只有IsTruncatedtrue时,才显示该参数。
2eEMmhmLa1b7Bbj9UzCgZUGj8DpDeG5TbNknuNKNP2h84KjJRnAb7vzzSDkYNmsidnAybyJYBfnPPB6xfgw54B1Wub2KQmC8LofzqBW2Y****
RequestIdstring

请求 ID。

0D85B43D-EF98-396D-B426-837E428D2D39
TotalCountsinteger

符合请求参数条件的数据总条数。

110
MaxResultsinteger

每页的最大数据条数。

取值范围:1~100。

默认值:10。

10
IsTruncatedboolean

返回结果是否被截断。取值:

  • true:已截断。
  • false:未截断。
false
UserProvisioningEventsobject []

RAM 用户同步事件列表。

UserProvisioningIdstring

RAM 用户同步的 ID。

up-002axzhapcbz6e63****
PrincipalIdstring

RAM 用户同步的身份 ID。取值:

  • PrincipalType取值为Group时,该值为云 SSO 用户组 ID(g-********)。
  • PrincipalType取值为User时,该值为云 SSO 用户 ID(u-********)。
g-02ha881d*****
TargetPathstring

RAM 用户同步的目标的 RD 路径。

rd-******/root/test**
ErrorInfostring

RAM 用户同步事件上次执行失败的错误信息。

OperationConflict.UserProvisioning.Process.fail.ImsUserExists
SourceTypestring

源操作类型。取值:

  • StartProvisioning:启用 RAM 用户同步。
  • DeleteProvisioning:删除 RAM 用户同步。
  • AddUserToGroup:用户加入用户组。
  • RemoveUserFromGroup:用户从用户组移出。
  • UserProvisioningDeletionClearing:删除 RAM 用户同步之后,后台进行资源清理。
StartProvisioning
UpdateTimestring

修改时间。

2022-11-28T03:55:55Z
DuplicationStrategystring

冲突策略。当云 SSO 用户同步到 RAM 时,如果 RAM 中存在同名用户时的处理策略。取值:

  • KeepBoth:两者都保留。当云 SSO 用户被同步到 RAM 时,如果 RAM 已经存在同名用户,则对云 SSO 用户的用户名添加后缀_sso后尝试创建该用户名的 RAM 用户。
  • TakeOver:替换。当云 SSO 用户被同步到 RAM 时,如果 RAM 已经存在同名用户,则直接将已经存在的 RAM 用户替换为云 SSO 同步用户。
KeepBoth
DeletionStrategystring

删除策略。删除 RAM 用户同步时,对已同步的 RAM 用户的处理策略。取值:

  • Delete:删除。删除 RAM 用户同步时,会删除从云 SSO 已经同步到 RAM 中的 RAM 用户。
  • Keep:保留。删除 RAM 用户同步时,会保留从云 SSO 已经同步到 RAM 中的 RAM 用户。
Keep
PrincipalNamestring

RAM 用户同步的身份名称。取值:

  • PrincipalType取值为Group时,该值为云 SSO 用户组名称。
  • PrincipalType取值为User时,该值为云 SSO 用户名称。
exampleGroupName
TargetNamestring

RAM 用户同步的目标名称。

TargetTypeRD-Account时,取值为 RD 账号名称。

exampleRdMember
ErrorCountlong

执行失败次数。

1
TargetIdstring

RAM 用户同步的目标 ID。

TargetTypeRD-Account时,取值为 RD 账号 ID。

153218*******
CreateTimestring

创建时间。

2022-11-28T03:55:55Z
DirectoryIdstring

目录 ID。

d-003qew84****
TargetTypestring

RAM 用户同步的目标类型。目前取值为RD-Account

RD-Account
EventIdstring

RAM 用户同步事件 ID。

upe-wjKyNDmZvyZOiRcJ****
PrincipalTypestring

RAM 用户同步的身份类型。取值:

  • User:表示该 RAM 用户同步的身份是云 SSO 用户。
  • Group:表示该 RAM 用户同步的身份是云 SSO 用户组。
Group
LatestAsyncTimestring

此事件上次执行的时间。

2022-11-28T03:55:55Z

示例

正常返回示例

JSON格式

{
  "NextToken": "2eEMmhmLa1b7Bbj9UzCgZUGj8DpDeG5TbNknuNKNP2h84KjJRnAb7vzzSDkYNmsidnAybyJYBfnPPB6xfgw54B1Wub2KQmC8LofzqBW2Y****",
  "RequestId": "0D85B43D-EF98-396D-B426-837E428D2D39",
  "TotalCounts": 110,
  "MaxResults": 10,
  "IsTruncated": false,
  "UserProvisioningEvents": [
    {
      "UserProvisioningId": "up-002axzhapcbz6e63****",
      "PrincipalId": "g-02ha881d*****",
      "TargetPath": "rd-******/root/test**",
      "ErrorInfo": "OperationConflict.UserProvisioning.Process.fail.ImsUserExists",
      "SourceType": "StartProvisioning",
      "UpdateTime": "2022-11-28T03:55:55Z",
      "DuplicationStrategy": "KeepBoth",
      "DeletionStrategy": "Keep",
      "PrincipalName": "exampleGroupName",
      "TargetName": "exampleRdMember",
      "ErrorCount": 1,
      "TargetId": "153218*******",
      "CreateTime": "2022-11-28T03:55:55Z",
      "DirectoryId": "d-003qew84****",
      "TargetType": "RD-Account",
      "EventId": "upe-wjKyNDmZvyZOiRcJ****",
      "PrincipalType": "Group",
      "LatestAsyncTime": "2022-11-28T03:55:55Z"
    }
  ]
}

错误码

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

  • 本页导读 (1)