UpdateWorkspaceUsersRole接口用于批量更新工作空间成员的角色信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateWorkspaceUsersRole

要执行的操作。取值：UpdateWorkspaceUsersRole。
RoleId Long 是 30

用户在工作空间内的角色ID。取值范围：

  • 25：空间管理员
  • 26：开发者
  • 27：分析者
  • 30：阅览者
UserIds String 是 136516262323****,124498444445****

用户ID。此处为Quick BI的UserID，而非阿里云的UID。

  • 支持批量传参，用户ID之间用半角逗号（,）隔开。
WorkspaceId String 是 95296e95-ca89-4c7d-8af9-dedf0ad0****

工作空间ID。

返回数据

名称 类型 示例值 描述
RequestId String 7AAB95D7-2E11-4FE2-94BC-858E4FC0C976

请求ID。
Result Struct

返回接口执行结果。
Failure Integer 1

修改失败的用户数。
FailureDetail Map {"notExsistUserIds" : "AE0150010004: The user is not a member of the group workspace."}

修改失败的原因。
Success Integer 1

修改成功的用户数。
Total Integer 2

修改用户的总数。
Success Boolean true

是否请求成功。取值范围：

  • true：请求成功，存在部分成员修改成功，部分修改失败的情况，失败的原因参考返回结果中的FailureDetail
  • false：请求失败，不会持久化任何数据

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=UpdateWorkspaceUsersRole
&RoleId=30
&UserIds=136516262323****,124498444445****
&WorkspaceId=95296e95-ca89-4c7d-8af9-dedf0ad0****
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>7AAB95D7-2E11-4FE2-94BC-858E4FC0C976</RequestId>
<Success>true</Success>
<Result>
    <FailureDetail>{"notExsistUserIds" : "AE0150010004: The user is not a member of the group workspace."}</FailureDetail>
    <Total>2</Total>
    <Failure>1</Failure>
    <Success>1</Success>
</Result>

JSON格式 

{"RequestId":"7AAB95D7-2E11-4FE2-94BC-858E4FC0C976","Success":"true","Result":{"FailureDetail":"{\"notExsistUserIds\" : \"AE0150010004: The user is not a member of the group workspace.\"}","Total":"2","Failure":"1","Success":"1"}}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 System.Param.empty This error code has been discarded. 错误码已废弃。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 User.RoleType.Valid The role ID is invalid. 无效的角色ID。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 Workspace.Type.Error The type of group workspace is invalid. 无效的群空间类型。
500 User.Not.WorkspaceAdmin Only administrators of the group workspace can perform this operation. 没有权限，您不是该群空间的管理员。
500 Remove.AdminRoleOf.WorkspaceOwner The owner of the group workspace must be assigned the administrator role. 不能移除群空间拥有者的管理员角色。
500 User.NotIn.Workspace The user is not a member of the group workspace. 该用户不在群空间中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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