调用SearchUser搜索用户_网盘与相册服务(PDS)-阿里云帮助中心

搜索用户。

调试

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

授权信息

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

请求语法

POST /v2/user/search

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 body
nick_name	string	否	用户昵称，最长 128 字符	pdsuer
nick_name_for_fuzzy	string	否	昵称-模糊搜索，最长 128 字符	la
user_name	string	否	用户名称，最长 128 字符	pds
phone	string	否	手机号	13900001111
email	string	否	邮箱地址	123@pds.com
status	string	否	用户状态 disabled（禁止） enabled（使能）	enabled
role	string	否	角色 superadmin（超级管理员） admin（管理员） user（用户）	user
marker	string	否	设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。默认值：无	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
limit	integer	否	限定此次返回资源的数量，取值范围为[1,100]，默认返回 100	100

返回参数

名称	类型	描述	示例值
	object	Schema of Response
next_marker	string	下一页起始资源标识符, 最后一页该值为空	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
items	array	用户信息列表
	User	用户信息

示例

正常返回示例

JSON格式

{
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "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
    }
  ]
}

错误码

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