文档

GetUserProvisioningEvent - 查询RAM用户同步事件

更新时间:
一键部署

调用GetUserProvisioningEvent查询RAM用户同步事件信息。

调试

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

授权信息

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

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

请求参数

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

RAM 用户同步事件 ID。

upe-wjKyNDmZvyZOiRcJ****
DirectoryIdstring

目录 ID。

d-003qew84****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

B801715C-97EA-3067-AC97-EF1EBECBB39C
UserProvisioningEventobject

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 用户同步之后,后台进行资源清理。
AddUserToGroup
UpdateTimestring

修改时间。

2022-11-28T03:55:42Z
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 用户。
Delete
PrincipalNamestring

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

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

RAM 用户同步的目标名称。

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

exampleRdMember
ErrorCountlong

执行失败次数。

3
TargetIdstring

RAM 用户同步的目标 ID。

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

1743382******
CreateTimestring

创建时间。

2022-11-28T03:55:42Z
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:42Z

示例

正常返回示例

JSON格式

{
  "RequestId": "B801715C-97EA-3067-AC97-EF1EBECBB39C",
  "UserProvisioningEvent": {
    "UserProvisioningId": "up-002axzhapcbz6e63****",
    "PrincipalId": "g-02ha881d*****",
    "TargetPath": "rd-******/root/test**",
    "ErrorInfo": "OperationConflict.UserProvisioning.Process.fail.ImsUserExists",
    "SourceType": "AddUserToGroup",
    "UpdateTime": "2022-11-28T03:55:42Z",
    "DuplicationStrategy": "KeepBoth",
    "DeletionStrategy": "Delete",
    "PrincipalName": "exampleGroupName",
    "TargetName": "exampleRdMember",
    "ErrorCount": 3,
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "TargetType": "RD-Account",
    "EventId": "upe-wjKyNDmZvyZOiRcJ****",
    "PrincipalType": "Group",
    "LatestAsyncTime": "2022-11-28T03:55:42Z"
  }
}

错误码

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

  • 本页导读 (1)