Drive and Photo Service (PDS) の SearchUser API によるユーザー検索 - PDS - Alibaba Cloud -

ユーザーを検索します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST /v2/user/search HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
domain_id	string	必須	ドメイン ID。
body	object	任意	リクエストボディ。
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`: ユーザーは有効化されています。列挙値: disabled : disabled enabled : enabled	enabled
role	string	任意	ユーザーのロール。有効な値は以下のとおりです。 `superadmin`: スーパー管理者 `admin`: 管理者 `user`: 一般ユーザ列挙値: superadmin : super administrator admin : administrator user : user	user
marker	string	任意	ページネーション用マーカー。結果はアルファベット順で返され、マーカーの次のエントリから開始されます。このパラメーターが指定されていない場合、クエリはリストの先頭から開始されます。デフォルト値: None	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
limit	integer	任意	1 ページあたりに返されるユーザーの最大数。有効な値: 1 ～ 100。デフォルト値: 100。	100

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
next_marker	string	次のページの結果を取得するためのトークン。これ以上返す結果がない場合は、このパラメーターは空になります。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
items	array	ユーザーのリスト。
	User	ユーザー情報。

例

成功レスポンス

JSONJSON

{
  "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",
      "creator": "user1",
      "last_login_time": 0,
      "last_refresh_token_time": 0,
      "user_data": {
        "key": ""
      }
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。