ユーザーを一覧表示します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/user/list HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
必須 |
||
| body |
object |
任意 |
リクエストボディ。 |
|
| marker |
string |
任意 |
結果の開始位置を指定するページネーショントークン。 結果はアルファベット順に返されます。 このパラメーターを省略した場合、結果はリストの先頭から返されます。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| limit |
integer |
任意 |
返すユーザーの最大数。 |
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": ""
}
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。