DescribeGroupUser - App Streaming - Alibaba Cloud Documentation Center

Queries the members of 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeGroupUser	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the user group.	ug-12341234****
BizType	string	No	Note This parameter is not available for public use.	ENTERPRISE
SolutionId	string	No	Note This parameter is not available for public use.	co-0esnf80jab***
MaxResults	integer	No	The number of entries to return on each page.	10
NextToken	string	No	The token for the next query. You can obtain this parameter from the response parameters of the last call to this operation.	AAAAAV3MpHK****
Filter	string	No	The fuzzy search string that matches the username (EndUserId) and email address (Email) of the regular user.	user

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	AA8D67CB-345D-5CDA-986E-FFAC7D0****
Groups	array<object>	Note This field is deprecated.
group	object	The information about the user group.
GroupName	string	The name of the user group.
GroupId	string	The user group ID.	ug-91mvbosdjsdfh****
UserCount	string	The number of members in the user group.	1
Users	array<object>	The members.
user	object	The information about the member.
EndUserId	string	The user name.	alex****
Avatar	string	Note This field is deprecated.	https://avatar.****.com
Address	string	Note This field is deprecated.	xx-xx-xx
Phone	string	The mobile number.	188888****
Email	string	The email address.	alex****@aliyun.com
NickName	string	The display name.	alex
JobNumber	string	Note This field is deprecated.	123
GmtJoinGroup	string	The time when the user was added to the user group.	2024-08-26T02:59:22.000+00:00
GmtCreated	string	The time when the user was created.	2024-08-26T02:59:22.000+00:00
Remark	string	The remarks on the user.	remark
NextToken	string	The token for the next query. If NextToken is empty, all results have been queried.	AAAAAV3MpHK****

Examples

Sample success responses

JSONformat

{
  "RequestId": "AA8D67CB-345D-5CDA-986E-FFAC7D0****",
  "Groups": [
    {
      "GroupName": "",
      "GroupId": "ug-91mvbosdjsdfh****",
      "UserCount": 1
    }
  ],
  "Users": [
    {
      "EndUserId": "alex****",
      "Avatar": "https://avatar.****.com",
      "Address": "xx-xx-xx",
      "Phone": "188888****",
      "Email": "alex****@aliyun.com",
      "NickName": "alex",
      "JobNumber": 123,
      "GmtJoinGroup": "2024-08-26T02:59:22.000+00:00",
      "GmtCreated": "2024-08-26T02:59:22.000+00:00",
      "Remark": "remark"
    }
  ],
  "NextToken": "AAAAAV3MpHK****"
}

Error codes

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