文档

AddWorkspaceUsers - 批量添加成员到工作空间

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
WorkspaceIdstring

工作空间 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIdsstring

用户 ID。此处为 Quick BI 的 UserID,而非阿里云的 UID。

  • 支持批量传参,用户 ID 之间用半角逗号(,)隔开。
de4bc5f9429141cc8091cdd1c15b****
RoleIdlong

预置空间角色 ID。取值范围:

  • 25:空间管理员
  • 26:空间开发者
  • 27:空间分析师
  • 30:空间查看者
25

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Resultobject

返回接口执行结果。

Failureinteger

添加失败的用户数。

2
FailureDetailobject

添加失败的原因。

{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Successinteger

添加成功的用户数。

1
Totalinteger

添加用户的总数。

3
Successboolean

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

  • true:请求成功,存在添加部分成员成功,部分失败的情况,添加失败的原因参考返回结果中的 FailureDetail
  • false:请求失败,不会持久化任何数据
true

示例

正常返回示例

JSON格式

{
  "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
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400User.RoleType.ValidThe role ID is invalid.无效的角色ID。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.组织访问者不能具有自定义角色。
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.该角色具有分析员无法授予的权限。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。
500Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
500Viewer.AddInTo.WorkspaceOrganization members with viewer type are not allowed to add to workspace: %s.不允许将组织的访客类型用户添加到工作空间:%s。
500User.AlreadyIn.WorkspaceThis user already exists.该用户已在群空间中。
500User.AlreadyIn.RoleThe user is already assigned this role.用户已经拥有该角色。

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

变更历史

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