分组和成员_网盘与相册服务(PDS)-阿里云帮助中心

以下所有方法中的 options 参数是额外请求配置，详见 AxiosRequestConfig。

createGroup 方法

重要

需要Admin权限，或者分组管理员。

创建分组。

const result = await client.createGroup(params, options)

举例

await client.createGroup({
  group_name: 'test',
  description: '',
  is_root: true
})

参数

字段	类型	必选	说明
params	ICreatGroupReq	是	团队名
options	AxiosRequestConfig		请求参数

ICreatGroupReq

字段	类型	必选	说明
group_name	string	是	团队名
description	string		团队描述
is_root	boolean		是否root
parent_group_id	string		父group 与is_root互斥

字段	类型	必选	说明
result	IGroupItem	是	结果

IGroupItem

名称	位置	必选	说明
domain_id	string		域id
group_id	string		团队id
group_name	string		团队名
description	string		团队描述
created_at	Date		创建时间
updated_at	Date		更新时间

deleteGroup 方法

重要

需要Admin权限，或者分组管理员

删除group。

await client.deleteGroup(params, options)

举例

await client.deleteGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

字段	类型	必选	说明
group_id	string	是	团队id

无

updateGroup 方法

重要

需要Admin权限，或者分组管理员

更新group。

await client.updateGroup(params, options)

举例

await client.updateGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    group_name: 'new_name',
   description: 'test'
})

参数

字段	类型	必选	说明
params	IUpdateGroupReq	是	请求参数
options	AxiosRequestConfig		请求参数

IUpdateGroupReq

字段	类型	必选	说明
group_id	string	是	团队id
group_name	string		团队名称
description	string		是否root

字段	类型	必选	说明
result	IGroupItem	是	结果

updateGroupName 方法

重要

需要Admin权限，或者分组管理员

更新团队名称。

const result = await client.updateGroupName(params, options)

举例

await client.updateGroupName({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
   name: 'new_name'
})

参数

字段	类型	必选	说明
params	IUpdateGroupNameReq	是	请求参数
options	AxiosRequestConfig		请求参数

IUpdateGroupNameReq

字段	类型	必选	说明
group_id	string	是	团队id
name	string		团队名称

字段	类型	必选	说明
result	IGroupItem	是	结果

getGroup 方法

获取group信息。

const result = await client.getGroup(params, options)

举例

const groupInfo = await client.getGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

名称	类型	必选	说明
group_id	string	是	群id

字段	类型	必选	说明
result	IGroupItem	是	结果

listGroups 方法

获取group信息

await client.listGroups(params, options)

举例

await client.listGroups({
   limit: 100,
   marker:''
})

参数

字段	类型	必选	说明
params	IListReq	是	请求参数
options	AxiosRequestConfig		请求参数

IListReq

名称	类型	必选	说明
limit	number		返回数据最大条数,范围:[1-100]，默认:100
marker	string		查询起始标识

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

名称	位置	必选	说明
items	IGroupItem[]		团队列表
next_marker	string		下一次查询的起始标识

searchGroups 方法

搜索group 结果默认按照updated_at降序输出。

await client.searchGroups(params, options)

const {items=[]} = await client.listGroups({
   limit: 100,
   marker:'',
   group_name: 'test_group_name'
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

名称	类型	必选	说明
limit	number		返回数据最大条数,范围:[1-100]，默认:100
marker	string		查询起始标识
group_name	string		团队名称

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

名称	类型	必选	说明
items	IGroupItem[]		团队列表
next_marker	string		下一次查询的起始标识

listMembers 方法

重要

需要Admin权限，或者分组管理员

列举一个 group 下的所有子 group或user。

await client.listMembers(params, options)

举例

await client.listMembers({
   limit: 100,
   marker:'',
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
   member_type: 'group'
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

名称	类型	必选	说明
limit	number		返回数据最大条数,范围:[1-100]，默认:100
marker	string		查询起始标识
group_id	string	是	团队id
member_type	string	是	类型 'group_id' \| 'member_type'

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

名称	类型	说明
items	array	团队或者用户列表
next_marker	string	下一次查询的起始标识

createMembership 方法

重要

需要Admin权限，或者分组管理员

创建membership

const result = await client.createMembership(params, options)

举例

await client.createMembership({
      user_id: 'test',
      member_type: 'user',
      member_role: 'member',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

参数

字段	类型	必选	说明
params	IMembershipReq	是	请求参数
options	AxiosRequestConfig		请求参数

IMembershipReq

字段	类型	必选	说明
group_id	string	是	群id
user_id	string	Y1	用户id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成员类型： 1、user：子用户 2、group：子群组
member_role	string	是	群成员角色： 1、member：普通群成员 2、admin：群管理员，可以增删member（暂不支持） 3、owner：群所有者（暂时不支持）
description	string		群描述
is_root	bool		true则为顶层目录

Y1: user_id 和sub_group_id 互斥必选一个。

字段	类型	必选	说明
result	IMembershipItem	是	结果

IMembershipItem

名称	位置	说明
domain_id	string	域id
group_id	string	群id
user_id	string	用户id
sub_group_id	string	子群id
member_type	string	群成员类型
member_role	string	群成员角色
description	string	描述
created_at	Date	创建时间
updated_at	Date	更新时间

deleteMembership 方法

重要

需要Admin权限，或者分组管理员

删除membership

await client.deleteMembership(params, options)

举例

await client.deleteMembership({
      user_id: 'test',
      member_type: 'user',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

参数

字段	类型	必选	说明
params	IMembershipReq	是	请求参数
options	AxiosRequestConfig		请求参数

IMembershipReq

字段	类型	必选	说明
group_id	string	是	群id
user_id	string	Y1	用户id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成员类型： 1、user：子用户 2、group：子群组

Y1: user_id 和sub_group_id 互斥必选一个。

无

updateMembership 方法

重要

需要Admin权限，或者分组管理员

更新membership

await client.updateMembership(params, options)

举例

await client.updateMembership({
      user_id: 'test',
      member_type: 'user',
      member_role: 'member',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

参数

字段	类型	必选	说明
params	IMembershipReq	是	请求参数
options	AxiosRequestConfig		请求参数

IMembershipReq

字段	类型	必选	说明
group_id	string	是	群id
user_id	string	Y1	用户id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成员类型： 1、user：子用户 2、group：子群组
member_role	string	是	群成员角色： 1、member：普通群成员 2、admin：群管理员，可以增删member（暂不支持） 3、owner：群所有者（暂时不支持）
description	string		群描述

Y1: user_id 和sub_group_id 互斥必选一个。

字段	类型	必选	说明
result	IMembershipItem	是	结果

getMembership 方法

重要

需要Admin权限，或者分组管理员

查询 Membership。

const result = await client.getMembership(params, options)

举例

const info = await client.getMembership({
      user_id: 'test',
      member_type: 'user',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

名称	类型	必选	说明
group_id	string	是	群id
user_id	string	Y1	用户id
sub_group_id	string	Y1	子群id
member_type	string	是	群成员类型

Y1: user_id 和sub_group_id 互斥必选一个。

字段	类型	必选	说明
result	IMembershipItem	是	结果

listDirectChildMemberships 方法

重要

需要Admin权限，或者分组管理员

列举直接子成员。

const result= await client.listDirectChildMemberships(params, options)

举例

const {items=[]} = await client.listDirectChildMemberships({
  group_id:'',
  marker: '',
  member_type: 'user',
  limit: 100,
});

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

字段	类型	必选	说明
limit	number		返回数据最大条数,范围:[1-100]，默认:100
marker	string		查询起始标识
group_id	string	是	要列举哪一层group。 ""表示列举顶层的目录，否则需要传入正确的group_id并列举这个group下的成员
member_type	string		群成员类型 group：只返回group user：只返回user 空：返回group和user

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

名称	位置	说明
items	IMembershipItem[]	成员数组
next_marker	string

listDirectParentMemberships 方法

重要

需要Admin权限，或者分组管理员

获取群成员所在的直接上一级的群列表。

const result = await client.listDirectParentMemberships(params, options)

举例

const {items=[]} = await client.listDirectParentMemberships({
    user_id:'123456789',
      marker: '',
      member_type: 'user',
      limit: 100,
    })

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

字段	类型	必选	说明
limit	number		返回数据最大条数,范围:[1-100]，默认:100
marker	string		查询起始标识
sub_group_id	string	Y1	子群id。sub_group_id 和user_id 必选一个
user_id	string	Y1	用户id。 sub_group_id 和user_id 必选一个
member_type	string		群成员类型, 取值范围： group \| user

Y1: user_id 和sub_group_id 互斥必选一个。

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

名称	位置	说明
items	IMemberShipRes[]	成员数组
next_marker	string

hasMember 方法

重要

需要Admin权限，或者分组管理员

群成员关系判定

如果user所在group超过100个，同理对应到其上级上上级group等所在的supergroup个数，均要求在100个内，否在可能判定不准确。

const result = await client.hasMember(params, options)

举例

const hasUsre = await client.hasMember({
    user_id:'123456789',
    member_type: 'user',
    group_id: '123',
})


const hasGroup = await client.hasMember({
    sub_group_id:'123456789',
    member_type: 'group',
    group_id: '123',
})

参数

字段	类型	必选	说明
params	Object	是	请求参数
options	AxiosRequestConfig		请求参数

params

字段	类型	必选	说明
group_id	string	是	群id
user_id	string	Y1	用户id
sub_group_id	string	Y1	子群id，与 user_id 互斥
member_type	string		群成员类型, 取值范围： group \| user

Y1: user_id 和sub_group_id 互斥必选一个。

名称

位置

必选

说明

result

boolean

true: member属于group

false：不属于

createGroup 方法

举例

参数

返回

deleteGroup 方法

举例

参数

返回

updateGroup 方法

举例

参数

返回

updateGroupName 方法

举例

参数

返回

getGroup 方法

举例

参数

返回

listGroups 方法

举例

参数

返回

searchGroups 方法

参数

返回

listMembers 方法

举例

参数

返回

createMembership 方法

举例

参数

返回

deleteMembership 方法

举例

参数

返回

updateMembership 方法

举例

参数

返回

getMembership 方法

举例

参数

返回

listDirectChildMemberships 方法

举例

参数

返回

listDirectParentMemberships 方法

举例

参数

返回

hasMember 方法

举例

参数

返回