批量添加成员到工作空间。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:AddWorkspaceUsers |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
工作空间 ID。 |
95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| UserIds |
string |
是 |
用户 ID。此处为 Quick BI 的 UserID,而非阿里云的 UID。
|
de4bc5f9429141cc8091cdd1c15b**** |
| RoleId |
integer |
是 |
预置空间角色 ID。取值范围:
枚举值:
|
25 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Success |
boolean |
是否请求成功。取值范围:
|
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. | 用户已经拥有该角色。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。