QueryUserRoleInfoInWorkspace接口用于获取指定工作空间下成员角色信息。

请求参数

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

要执行的操作。取值:QueryUserRoleInfoInWorkspace。

UserId String f5698bedeb384b1986afccd9e434****

Quick BI用户ID。

WorkspaceId String 95296e95-ca89-4c7d-8af9-dedf0ad0****

工作空间ID。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Struct

成员的角色信息。

RoleCode String role_workspace_admin

成员角色对应的编码。

RoleId Long 25

成员角色的ID。

  • 25:管理员
  • 26:开发者
  • 27:分析者
  • 30:阅览者
RoleName String 管理员

成员角色的名称。

Success Boolean true

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

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryUserRoleInfoInWorkspace
&UserId=f5698bedeb384b1986afccd9e434****
&WorkspaceId=95296e95-ca89-4c7d-8af9-dedf0ad0****
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <RoleName>管理员</RoleName>
    <RoleCode>role_workspace_admin</RoleCode>
    <RoleId>25</RoleId>
</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"RoleName":"管理员","RoleCode":"role_workspace_admin","RoleId":"25"}}

错误码

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 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 User.RoleType.Valid The role ID is invalid. 无效的角色ID。
500 User.NotIn.Workspace The user is not a member of the group workspace. 该用户不在群空间中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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