AddUserToWorkspace接口用于在指定的工作空间添加成员。

请求参数

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

要执行的操作。取值：AddUserToWorkspace。
RoleId Long 是 25

角色ID。

  • 25：管理员
  • 26：开发者
  • 27：分析者
  • 30：阅览者
UserId String 是 de4bc5f9429141cc8091cdd1c15b****

被添加的Quick BI用户ID。
WorkspaceId String 是 95296e95-ca89-4c7d-8af9-dedf0ad0****

工作空间ID。

返回数据

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

请求ID。
Result Boolean true

返回接口执行结果。取值范围：

  • true：执行成功
  • false：执行失败
Success Boolean true

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

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

示例

请求示例

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

正常返回示例

XML格式 

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON格式 

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":"true"}

错误码

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 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 ApiUser.Not.Exists The specified user does not exist. 用户不存在。
500 Viewer.AddInTo.Workspace Organization members with viewer type are not allowed to add to workspace: %s. 不允许将组织的访客类型用户添加到工作空间：%s。
500 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。
500 User.AlreadyIn.Workspace This user already exists. 该用户已在群空间中。
500 User.AlreadyIn.Role The user is already assigned this role. 用户已经拥有该角色。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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