QueryUserGroupListByParentId接口用于获取指定父用户组下的子用户组信息。

请求参数

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

要执行的操作。取值:QueryUserGroupListByParentId。

ParentUserGroupId String 3d2c23d4-2b41-4af8-a1f5-f6390f32****

父用户组ID。

  • 当输入父用户组ID时,可以获取该ID下的子用户组信息。
  • 当输入-1时,可以获取根目录下的子用户组信息。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Array of Data

子用户组信息。

CreateTime String 2020-10-30 10:03:09

子用户组创建时间。

CreateUser String 136516262323****

子用户组创建者。此处为QuickBI的UserID,而非阿里云的UID。

IdentifiedPath String 2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****

子用户组的目录层级。

ModifiedTime String 2020-11-16 15:49:08

子用户组最新修改时间。

ModifyUser String 136516262323****

子用户组修改者。此处为QuickBI的UserID,而非阿里云的UID。

ParentUserGroupId String 3d2c23d4-2b41-4af8-a1f5-f6390f32****

父用户组ID。

UserGroupDescription String 用来测试的用户组

子用户组备注。

UserGroupId String f5eeb52e-d9c2-4a8b-80e3-47ab55c2****

子用户组ID。

UserGroupName String popapi测试分组

子用户组名称。

Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryUserGroupListByParentId
&ParentUserGroupId=3d2c23d4-2b41-4af8-a1f5-f6390f32****
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <ParentUserGroupId>3d2c23d4-2b41-4af8-a1f5-f6390f32****</ParentUserGroupId>
    <ModifyUser>136516262323****</ModifyUser>
    <ModifiedTime>2020-11-16 15:49:08</ModifiedTime>
    <CreateTime>2020-10-30 10:03:09</CreateTime>
    <IdentifiedPath>2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****</IdentifiedPath>
    <UserGroupName>popapi测试分组</UserGroupName>
    <UserGroupId>f5eeb52e-d9c2-4a8b-80e3-47ab55c2****</UserGroupId>
    <CreateUser>136516262323****</CreateUser>
    <UserGroupDescription>用来测试的用户组</UserGroupDescription>
</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":[{"ParentUserGroupId":"3d2c23d4-2b41-4af8-a1f5-f6390f32****","ModifyUser":"136516262323****","ModifiedTime":"2020-11-16 15:49:08","CreateTime":"2020-10-30 10:03:09","IdentifiedPath":"2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****","UserGroupName":"popapi测试分组","UserGroupId":"f5eeb52e-d9c2-4a8b-80e3-47ab55c2****","CreateUser":"136516262323****","UserGroupDescription":"用来测试的用户组"}]}

错误码

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 Internal.System.Error An internal system error occurred. 系统内部异常。

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