Mencari pengguna.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST /v2/user/search HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
Parameter permintaan. |
|
| nick_name |
string |
No |
Nama panggilan pengguna. Nama panggilan dapat memiliki panjang hingga 128 karakter. |
pdsuer |
| nick_name_for_fuzzy |
string |
No |
Nama panggilan yang digunakan untuk pencarian fuzzy. Nama panggilan dapat memiliki panjang hingga 128 karakter. |
la |
| user_name |
string |
No |
Nama pengguna. Nama dapat memiliki panjang hingga 128 karakter. |
pds |
| phone |
string |
No |
Nomor ponsel pengguna. |
13900001111 |
|
string |
No |
Alamat email pengguna. |
123@pds.com |
|
| status |
string |
No |
Status pengguna. Nilai yang valid:
Valid values:
|
enabled |
| role |
string |
No |
Peran pengguna. Nilai yang valid:
Valid values:
|
user |
| marker |
string |
No |
Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Anda tidak perlu menentukan parameter ini pada permintaan pertama. Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai marker. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| limit |
integer |
No |
Jumlah maksimum hasil yang dikembalikan. Nilai yang valid: 1 hingga 100. Nilai default: 100. |
100 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter respons. |
||
| next_marker |
string |
Token paginasi. Token ini dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika next_marker kosong, berarti tidak ada halaman berikutnya. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| items |
array |
Informasi tentang pengguna. |
|
| User |
Informasi tentang satu pengguna. |
Contoh
Respons sukses
JSONformat
{
"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
}
]
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.