ListByUserGroupId接口用于根据用户组ID批量查询用户组信息。

请求参数

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

要执行的操作。取值：ListByUserGroupId。
UserGroupIds String 是 34fe-***-6dcb,84q9-****-4a274

要查询的用户组ID，批量查询时用半角逗号（,）隔开。

返回数据

名称 类型 示例值 描述
RequestId String 617277C3-30E3-448E-B683-4720ABA47E31

请求ID。
Result Struct

返回用户组查询结果。
FailedUserGroupIds List []

查询失败的用户组ID。
UserGroupModels Array of UserGroupModels

查询到的用户组详情。
CreateTime String 2021-03-15 17:13:55

创建时间。
CreateUser String 46e5*******ee22e2a292704c8

创建者在Quick BI的UserID。
IdentifiedPath String 2fe4fbd8-****-af083ea/34fd1-****-dcbc33f

用户组路径。
ModifiedTime String 2021-03-15 20:36:40

修改时间。
ModifyUser String 46e5*******ee22e2a292704c8

修改者在Quick BI的UserID。
ParentUsergroupId String 2fe4fbd8-588f-489a-b3e1-e92c7af083ea

上级用户组的ID。
UsergroupDesc String 描述信息

用户组描述信息。
UsergroupId String 34fd141d-****-4093-8c33-8e066dcbc33f

用户组ID。
UsergroupName String pop测试用户组

用户组名称。
Success Boolean true

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

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=ListByUserGroupId
&UserGroupIds=34fe-***-6dcb,84q9-****-4a274
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>617277C3-30E3-448E-B683-4720ABA47E31</RequestId>
<Success>true</Success>
<Result>
    <UserGroupModels>
        <ModifyUser>46e5*******ee22e2a292704c8</ModifyUser>
        <ModifiedTime>2021-03-15 20:36:40</ModifiedTime>
        <UsergroupDesc/>
        <CreateTime>2021-03-15 17:13:55</CreateTime>
        <IdentifiedPath>2fe4fbd8-****-af083ea/34fd1-****-dcbc33f</IdentifiedPath>
        <CreateUser>46e5*******ee22e2a292704c8</CreateUser>
        <ParentUsergroupId>2fe4fbd8-588f-489a-b3e1-e92c7af083ea</ParentUsergroupId>
        <UsergroupName>pop测试用户组</UsergroupName>
        <UsergroupId>34fd141d-****-4093-8c33-8e066dcbc33f</UsergroupId>
    </UserGroupModels>
    <FailedUserGroupIds>[ ]</FailedUserGroupIds>
</Result>

JSON格式 

{"RequestId":"617277C3-30E3-448E-B683-4720ABA47E31","Success":"true","Result":{"UserGroupModels":[{"ModifyUser":"46e5*******ee22e2a292704c8","ModifiedTime":"2021-03-15 20:36:40","UsergroupDesc":"","CreateTime":"2021-03-15 17:13:55","IdentifiedPath":"2fe4fbd8-****-af083ea/34fd1-****-dcbc33f","CreateUser":"46e5*******ee22e2a292704c8","ParentUsergroupId":"2fe4fbd8-588f-489a-b3e1-e92c7af083ea","UsergroupName":"pop测试用户组","UsergroupId":"34fd141d-****-4093-8c33-8e066dcbc33f"}],"FailedUserGroupIds":"[ ]"}}

错误码

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 System.Param.empty This error code has been discarded. 错误码已废弃。
500 Usergroup.Not.Exist The user group does not exist. 用户组不存在。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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