AddWorkspaceUsers接口用于批量添加工作空间成员。

请求参数

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

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

角色ID。取值范围：

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

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

  • 支持批量传参，用户ID之间用半角逗号（,）隔开。
WorkspaceId String 是 95296e95-ca89-4c7d-8af9-dedf0ad0****

工作空间ID。

返回数据

名称 类型 示例值 描述
RequestId String 7AAB95D7-2E11-4FE2-94BC-858E4FC0C976

请求ID。
Result Struct

返回接口执行结果。
Failure Integer 2

添加失败的用户数。
FailureDetail Map {"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}

添加失败的原因。
Success Integer 1

添加成功的用户数。
Total Integer 3

添加用户的总数。
Success Boolean true

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

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

示例

请求示例

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

正常返回示例

XML格式 

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

JSON格式 

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

错误码

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 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 System.Param.empty This error code has been discarded. 错误码已废弃。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 User.RoleType.Valid The role ID is invalid. 无效的角色ID。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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