调用AddWorkspaceUsers批量添加成员到工作空间-智能商业分析 Quick BI-阿里云

批量添加成员到工作空间。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:AddWorkspaceUsers	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	工作空间 ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	是	用户 ID。此处为 Quick BI 的 UserID，而非阿里云的 UID。支持批量传参，用户 ID 之间用半角逗号（,）隔开。	de4bc5f9429141cc8091cdd1c15b****
RoleId	long	是	预置空间角色 ID。取值范围： 25：空间管理员 26：空间开发者 27：空间分析师 30：空间查看者	25

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功，存在添加部分成员成功，部分失败的情况，添加失败的原因参考返回结果中的 FailureDetail false：请求失败，不会持久化任何数据	true
RequestId	string	请求 ID。	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	返回接口执行结果。
Failure	integer	添加失败的用户数。	2
FailureDetail	object	添加失败的原因。	{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Success	integer	添加成功的用户数。	1
Total	integer	添加用户的总数。	3

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 2,
    "FailureDetail": {
      "2046274934845893": "AE0150010001: This user already exists.",
      "1213444447906552": "AE0150010001: This user already exists."
    },
    "Success": 1,
    "Total": 3
  }
}

错误码

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	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	组织访问者不能具有自定义角色。
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	该角色具有分析员无法授予的权限。
400	Workspace.Not.Exist	The group workspace does not exist.	群空间不存在。
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	User.AlreadyIn.Workspace	This user already exists.	该用户已在群空间中。
400	User.AlreadyIn.Role	The user is already assigned this role.	用户已经拥有该角色。

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

变更历史

变更时间	变更内容概要	操作
2023-08-07	OpenAPI 错误码发生变更	查看变更详情