All Products
Search
Document Center

Quick BI:QueryUserGroupMember

Last Updated:Apr 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Retrieve the list of members under a 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:QueryUserGroupMemberlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserGroupIdstringYes

User group ID.

2fe4fbd8-588f-489a-b3e1-e92c7af0****
KeywordstringNo

Keyword for the username or nickname of the user group member.

test

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful. Possible values:

  • true: The request was successful.
  • false: The request failed.
true
RequestIdstring

Request ID.

48C930FF-DFCF-5986-902B-E24C202E2443
Resultarray<object>

The result of the request for the user group member list.

Dataobject
ParentUserGroupNamestring

Name of the parent user group.

test
IsUserGroupboolean

Indicates whether it is a user group. Possible values:

  • true: It is a user group.
  • false: It is a user.
true
Namestring

Name or nickname of the user group or its member.

test
ParentUserGroupIdstring

ID of the parent user group.

2fe4fbd8-588f-489a-b3e1-e92c7af0****
Idstring

ID of the user group or the user group member.

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

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "48C930FF-DFCF-5986-902B-E24C202E2443",
  "Result": [
    {
      "ParentUserGroupName": "test",
      "IsUserGroup": true,
      "Name": "test",
      "ParentUserGroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "Id": "3d2c23d4-2b41-4af8-a1f5-f6390f32****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The 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.The specified organizational unit does not exist.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400Usergroup.Not.ExistThe user group does not exist.The user group does not exist.
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.

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