文档

ListGroupMember - 列举群组成员

更新时间:

列举团队成员。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/group/list_member

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

group_idstring

目标群组 ID,表示将列举哪个群组下的成员

3e5***2c2
member_typestring

列举的成员类型,不传则两种都返回

  • user(用户)

  • group(群组)

注意:群组只能作为一个群组的成员,不能同时成为多个群组的成员。 用户可以同时成为多个群组的成员

user
limitinteger

限定此次返回资源的数量,取值范围[1,100]。 返回结果可以小于指定的数量,但不能多于指定的数量。
默认值:100

50
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。
默认值:无

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

返回参数

名称类型描述示例值
object

返回的结构体

user_itemsarray

用户列表

User

用户信息

group_itemsarray

群组列表

Group

群组信息

next_markerstring

下一页起始资源标识符, 最后一页该值为空。

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1

示例

正常返回示例

JSON格式

{
  "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": 1670573504600,
      "updated_at": 1670573504600,
      "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "is_sync": true
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1"
}

错误码

访问错误中心查看更多错误码。