添加成员到指定工作空间。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 工作空间 ID。 | 95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| UserId | string | 是 | 被添加的 Quick BI 用户 ID。 | de4bc5f9429141cc8091cdd1c15b**** |
| RoleId | long | 是 | 预置空间角色 ID。取值范围：
| 25 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": true,
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | 空间不在组织内。 |
| 400 | User.RoleType.Valid | The role ID is invalid. | 无效的角色ID。 |
| 400 | Workspace.Not.Exist | The group workspace does not exist. | 群空间不存在。 |
| 400 | Workspace.Type.Error | The type of group workspace is invalid. | 无效的群空间类型。 |
| 400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限，您不是该群空间的管理员。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | Viewer.AddInTo.Workspace | Organization members with viewer type are not allowed to add to workspace: %s. | 不允许将组织的访客类型用户添加到工作空间：%s。 |
| 400 | Invalid.User.Organization | The user is not in your organization. | 该用户不在您的组织中。 |
| 400 | User.AlreadyIn.Workspace | This user already exists. | 该用户已在群空间中。 |
| 400 | User.AlreadyIn.Role | The user is already assigned this role. | 用户已经拥有该角色。 |
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | AnalystUser.NotSupport.AdminOrDevRole | Analyst users do not support granting workspace administrator or developer roles. | 分析师用户不支持授予工作空间管理员或开发者员角色。 |
| 400 | UserAnalyst.NotSupport.ThisRole | This role has permissions that analysts cannot grant. | 该角色具有分析员无法授予的权限。 |
| 400 | Viewer.CannotHave.CustomRole | Organization viewer cannot have custom roles. | 组织访问者不能具有自定义角色。 |
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | 没有权限，您不是组织管理员。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。 |
| 400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
| 400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-07 | OpenAPI 错误码发生变更 | 查看变更详情 |