Use QueryUserGroupListByParentId to get child user groups - Quick BI - Alibaba Cloud - Quick BI

Queries child user groups under a specified parent user group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryUserGroupListByParentId

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentUserGroupId	string	Yes	The ID of the parent user group. To query child user groups under a specific parent group, enter the parent user group ID. To query child user groups under the root directory, enter -1.	3d2c23d4-2b41-4af8-a1f5-f6390f32****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	72B19D61-B37A-5C7A-9389-0856CD7935B3
Result	array<object>	The child user groups returned.
	object
CreateTime	string	The time when the sub-user group was created.	2020-10-30 10:03:09
CreateUser	string	The Quick BI user ID of the user who created the child user group. This is not the Alibaba Cloud UID.	136516262323****
IdentifiedPath	string	The directory path of the child user group.	2fe4fbd8-588f-489a-b3e1-e92c7af0**/3d2c23d4-2b41-4af8-a1f5-f6390f32/f5eeb52e-d9c2-4a8b-80e3-47ab55c2**
ModifiedTime	string	The time when the sub-user group was last modified.	2020-11-16 15:49:08
ModifyUser	string	The Quick BI user ID of the user who last modified the child user group. This is not the Alibaba Cloud UID.	136516262323****
ParentUserGroupId	string	The ID of the parent user group.	3d2c23d4-2b41-4af8-a1f5-f6390f32****
UserGroupDescription	string	The description of the sub-user group.	用来测试的用户组
UserGroupId	string	The ID of the sub-user group.	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
UserGroupName	string	The name of the sub-user group.	popapi测试分组

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	UserGroup.NotIn.Organization	The user group is not in the current organization.	Usergroup is not belong to current organization.
400	Usergroup.Not.Exist	The user group does not exist.	The user group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.