QueryUserGroupListByParentId - Quick BI - Alibaba Cloud Documentation Center

You can this operation to obtain information about child user groups under a specified parent user group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ParentUserGroupId	string	Yes	The ID of the parent user group. If you enter the ID of the parent user group, you can obtain the information of the child user group under this ID. If you enter -1, you can obtain the sub-user group information under the root directory.	3d2c23d4-2b41-4af8-a1f5-f6390f32****

Response parameters

Parameter	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 information about the sub-user group.
Data	object
IdentifiedPath	string	Directory level of the sub-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
CreateUser	string	The creator of the sub-user group. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.	136516262323****
CreateTime	string	The time when the sub-user group was created.	2020-10-30 10:03:09
UserGroupId	string	The ID of the sub-user group.	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
UserGroupName	string	The name of the sub-user group.	popapi test group
ModifyUser	string	The user who modified the subgroup. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.	136516262323****
ParentUserGroupId	string	The ID of the parent user group.	3d2c23d4-2b41-4af8-a1f5-f6390f32****
UserGroupDescription	string	The description of the sub-user group.	User Group for Testing

Examples

Sample success responses

JSONformat

{
  "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 test group\n",
      "ModifyUser": "136516262323****",
      "ParentUserGroupId": "3d2c23d4-2b41-4af8-a1f5-f6390f32****",
      "UserGroupDescription": "User Group for Testing\n"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
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.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

For a list of error codes, visit the Service error codes.