ListGroupMember - Drive and Photo Service - Alibaba Cloud Documentation Center

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

POST /v2/group/list_member HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
group_id	string	Yes	The ID of the group of which you want to query members.	3e5***2c2
member_type	string	No	The member type. If you do not specify this parameter, both types of members are returned. Valid values: user group Note: A group can be a member of only one group. It cannot be a member of multiple groups. A user can be a member of multiple groups.	user
limit	integer	No	The maximum number of results to return. Valid values: 1 to 100. Default value: 100.	50
marker	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
user_items	array	The information about the users.
	User	The information about the user.
group_items	array	The information about the groups.
	Group	The information about a group.
next_marker	string	A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1

Examples

Sample success responses

JSONformat

{
  "user_items": [
    {
      "domain_id": "bj1",
      "user_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "avatar": "http://aa.com/1.jpg",
      "created_at": 1639762579768,
      "updated_at": 1639762579768,
      "email": "a@aliyunpds.com",
      "nick_name": "001",
      "phone": 13900001111,
      "role": "user",
      "status": "enabled",
      "user_name": "pds",
      "description": "vipuser",
      "default_drive_id": 1,
      "user_data": {
        "key": ""
      },
      "creator": "user1",
      "punishments": [
        {
          "punish_flag": 0,
          "starts_at": "",
          "ends_at": "",
          "impermanent": true
        }
      ],
      "is_sync": true
    }
  ],
  "group_items": [
    {
      "domain_id": "bj1",
      "group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
      "group_name": "test group",
      "description": "created by system",
      "created_at": 0,
      "updated_at": 0,
      "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "is_sync": true
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1"
}

Error codes

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