Javascript SDK分组和成员的功能及使用方法_网盘与相册服务(PDS)-阿里云帮助中心

本篇介绍分组和成员相关方法。

说明

请求参数中的 options: IPDSRequestConfig 基于 axios 的 request config 封装，详情请看：AxiosRequestConfig。

createGroup 方法

重要

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

创建分组。

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

举例

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

参数

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

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	number		创建时间
updated_at	number		更新时间

deleteGroup 方法

重要

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

删除group。

await client.deleteGroup(params, options)

举例

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

参数

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

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	IPDSRequestConfig		请求参数

IUpdateGroupReq

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

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

getGroup 方法

获取group信息。

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

举例

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

参数

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

params

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

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

listGroups 方法

获取group信息

await client.listGroups(params, options)

举例

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

参数

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

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	IPDSRequestConfig		请求参数

params

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

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

IListRes

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

listGroupMembers 方法

重要

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

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

await client.listGroupMembers(params, options)

举例

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

参数

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

params

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

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

IListGroupMembersRes

名称	类型	说明
user_items	IUserItem[]	用户列表
group_items	IGroupItem[]	团队列表
next_marker	string	下一次查询的起始标识

addGroupMember 方法

重要

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

添加用户到Group。

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

举例

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

参数

字段	类型	必选	说明
params	IAddGroupMemberReq	是	请求参数
options	IPDSRequestConfig		请求参数

IAddGroupMemberReq

字段	类型	必选	说明
group_id	string	是	群id
member_id	string	是	用户id
member_type	string	是	群成员类型： 1、user：子用户这里仅支持 user，如果要添加 group 请用 createGroup 方法。

无

removeGroupMember 方法

重要

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

从Group中删除成员。

await client.removeGroupMember(params, options)

举例

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

参数

字段	类型	必选	说明
params	IRemoveGroupMemberReq	是	请求参数
options	IPDSRequestConfig		请求参数

IRemoveGroupMemberReq

字段	类型	必选	说明
group_id	string	是	群id
member_id	string	是	用户id
member_type	string	是	成员类型，当前只能移除用户，群组移除可以通过删除群组完成。 user

无

createGroup 方法

举例

参数

返回

deleteGroup 方法

举例

参数

返回

updateGroup 方法

举例

参数

返回

getGroup 方法

举例

参数

返回

listGroups 方法

举例

参数

返回

searchGroups 方法

参数

返回

listGroupMembers 方法

举例

参数

返回

addGroupMember 方法

举例

参数

返回

removeGroupMember 方法

举例

参数

返回