文档

QueryUserGroupListByParentId - 查询父用户组下的子用户组列表

更新时间:

获取指定父用户组下的子用户组信息。

调试

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

授权信息

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

请求参数

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

父用户组 ID。

  • 当输入父用户组 ID 时,可以获取该 ID 下的子用户组信息。
  • 当输入-1 时,可以获取根目录下的子用户组信息。
3d2c23d4-2b41-4af8-a1f5-f6390f32****

返回参数

名称类型描述示例值
object
Successboolean

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

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

请求 ID。

72B19D61-B37A-5C7A-9389-0856CD7935B3
Resultobject []

子用户组信息。

IdentifiedPathstring

子用户组的目录层级。

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

子用户组最新修改时间。

2020-11-16 15:49:08
CreateUserstring

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

136516262323****
CreateTimestring

子用户组创建时间。

2020-10-30 10:03:09
UserGroupIdstring

子用户组 ID。

f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
UserGroupNamestring

子用户组名称。

popapi测试分组
ModifyUserstring

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

136516262323****
ParentUserGroupIdstring

父用户组 ID。

3d2c23d4-2b41-4af8-a1f5-f6390f32****
UserGroupDescriptionstring

子用户组备注。

用来测试的用户组

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400UserGroup.NotIn.OrganizationThe user group is not in the current organization.用户组不在当前组织内。
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
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不能为空。
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.操作组件不存在或已被删除。

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

  • 本页导读 (0)
文档反馈