Use SearchUser to search for users - Drive and Photo Service

Searches for users.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v2/user/search HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
nick_name	string	No	The nickname of the user. The nickname can be up to 128 characters in length.	pdsuer
nick_name_for_fuzzy	string	No	The nickname used for fuzzy searches. The nickname can be up to 128 characters in length.	la
user_name	string	No	The name of the user. The name can be up to 128 characters in length.	pds
phone	string	No	The mobile number of the user.	13900001111
email	string	No	The email address of the user.	123@pds.com
status	string	No	The state of the user. Valid values: disabled: The user is prohibited from logon. enabled: The user is in a normal state. Valid values: disabled : Disabled enabled : Enabled	enabled
role	string	No	The role of the user. Valid values: superadmin admin user Valid values: superadmin : Super administrator admin : Administrator user : User	user
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
limit	integer	No	The maximum number of results to return. Valid values: 1 to 100. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
items	array	The information about the users.
	User	The information about a user.

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.