DescribeUsers - App Streaming - Alibaba Cloud Documentation Center

Mengkueri informasi akun kemudahan, seperti nama pengguna, alamat email, dan nama catatan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeUsers

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
MaxResults	integer	No	Jumlah baris per halaman untuk kueri terpaginasi. Rentang nilai: 1 hingga 500. Nilai default: 200.	10
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Anda tidak perlu mengatur parameter ini saat memanggil API untuk pertama kali. Jika satu kueri tidak mengembalikan semua hasil, NextToken yang dikembalikan tidak kosong. Anda dapat meneruskan NextToken yang dikembalikan dalam kueri berikutnya untuk melanjutkan kueri.	caeba0bbb2be03f84eb48b699f0a****
Filter	string	No	String pencarian fuzzy. Mendukung pencocokan nama pengguna (EndUserId) dan email (Email). Bidang ini mendukung wildcard (). Misalnya, jika bidang ini diatur ke `am`, semua hasil yang nama pengguna atau emailnya dimulai dengan `a` dan diakhiri dengan `m` akan dikembalikan.	a*m
FilterMap	object	No
	string	No
EndUserIds	array	No	Daftar nama pengguna (EndUserId) yang akan dicocokkan secara tepat.
	string	No	Pencocokan tepat berdasarkan nama pengguna (EndUserId). Mengkueri informasi akun yang nama penggunanya cocok.	alice
ExcludeEndUserIds	array	No	Daftar nama pengguna (EndUserId) yang akan dikecualikan secara tepat.
	string	No	Pengecualian tepat berdasarkan nama pengguna (EndUserId). Mengkueri daftar akun yang tidak mengandung nama pengguna ini.	tony
OrgId	string	No	Pencocokan tepat berdasarkan ID organisasi. Mengkueri daftar akun yang termasuk dalam organisasi ini.	org-4mdgc1cocc59z****
GroupId	string	No	Pencocokan tepat berdasarkan ID kelompok pengguna. Mengkueri daftar akun yang termasuk dalam kelompok pengguna ini.	ug-12341234****
ShowExtras	object	No	Catatan Parameter ini tidak tersedia untuk penggunaan eksternal.
FilterWithAssignedResources	object	No	Catatan Parameter ini tidak tersedia untuk penggunaan eksternal.
IsQueryAllSubOrgs	boolean	No	Mengkueri informasi tambahan pengguna.
FilterWithAssignedResource	object	No	Memfilter pengguna berdasarkan apakah Sumber daya cloud telah dialokasikan.
	string	No	The key is one of the following types, and the value is a Boolean type. Pass true to filter users assigned with this cloud resource. Desktop: Cloud computer. DesktopGroup: Shared cloud computer. CloudDrive: Enterprise drive (user personal drive). App: Cloud application.	App:aig-jfgmanbo****
Status	integer	No	Apakah akan mengkueri pengguna di bawah sub-organisasi.
ExcludeGroupId	string	No
BusinessChannel	string	No	Status.
ExcludeGroupId	string	No
BusinessChannel	string	No	Saluran.	ENTERPRISE

Elemen respons

Element	Type	Description	Example
	object	Kumpulan informasi yang dikembalikan.
RequestId	string	ID permintaan.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	Token yang digunakan untuk kueri berikutnya. NextToken yang kosong menunjukkan bahwa tidak ada kueri berikutnya.	caeba0bbb2be03f84eb48b699f0a4883
Users	array<object>	Kumpulan informasi akun kemudahan.
	array<object>	Kumpulan informasi akun kemudahan.
Id	integer	ID akun kemudahan.	4205**
EndUserId	string	Nama pengguna.	alice
Email	string	Email.	username@example.com
Phone	string	Nomor telepon seluler. Parameter ini tidak dikembalikan jika tidak diatur.	1381111****
Status	integer	Status. Valid values: 0 : Normal. 9 : Terkunci.	0
OwnerType	string	Tipe akun kemudahan, termasuk: Tipe aktivasi administrator: Administrator mengatur nama pengguna dan kata sandi pengguna. Notifikasi pengguna, seperti notifikasi pengaturan ulang kata sandi, dikirim ke email atau telepon seluler administrator. Tipe aktivasi pengguna: Administrator mengatur nama pengguna dan email atau telepon seluler tempat pengguna menerima notifikasi. Notifikasi pengguna, seperti notifikasi aktivasi cloud computer (termasuk kata sandi awal), dikirim ke email atau telepon seluler pengguna. Valid values: CreateFromManager : Aktivasi administrator. Normal : Aktivasi pengguna.	Normal
Remark	string	Catatan akun kemudahan.	Test user.
OrgId	string	ID departemen tempat akun kemudahan berada. Catatan Parameter ini akan segera dihentikan penggunaannya.	org-4mdgc1cocc59z****
WyId	string	ID unik global akun kemudahan.	41fd1254d8f7****
IsTenantManager	boolean	Apakah akun tersebut adalah administrator pengguna. Jika akun kemudahan yang dibuat bertipe aktivasi administrator, administrator pengguna harus ditentukan. Notifikasi seperti pengaturan ulang kata sandi yang diinisiasi oleh pengguna akhir melalui klien akan dikirim ke email atau telepon seluler administrator pengguna ini. Untuk informasi lebih lanjut, lihat Membuat akun kemudahan.	true
Groups	array<object>	Kumpulan kelompok pengguna tempat akun kemudahan berada.
	object	Properti kelompok pengguna tempat akun kemudahan berada.
GroupId	string	The user group ID.	ug-12341234****
GroupName	string	The user group name.	用户组1
Orgs	array<object>	Kumpulan departemen tempat akun kemudahan berada.
	object	Properti departemen tempat akun kemudahan berada.
OrgId	string	The department ID.	org-4mdgc1cocc59z****
OrgName	string	The department name.	部门1
OrgNamePath	string
Avatar	string	URL avatar pengguna.	https://cdn.*****
Address	string	Alamat kerja pengguna.	杭州市***
NickName	string	Nama panggilan pengguna. Nilai diambil dengan urutan berikut: RealNickName Remark EndUserId	李**
RealNickName	string	Nama tampilan pengguna.	李**
JobNumber	string	Nomor karyawan pengguna.	A10000**
Extras	object	Informasi tambahan pengguna.
AssignedResourceCount	object	The number of assigned cloud resources.
	any	Supported cloud resource types: `Desktop`: cloud desktop. `DesktopGroup`: shared cloud desktop. `CloudDrive`: enterprise cloud drive (user's personal drive). `APP`: cloud application.	Desktop: 3
ResourcePolicyList	array<object>
	object
PolicyId	string
PolicyName	string
ExternalName	string	Nama pengguna yang diimpor secara eksternal. Catatan Bidang ini saat ini tidak tersedia untuk penggunaan eksternal.	马**
Properties	array<object>	Properti pengguna.
	object	Daftar properti.
Key	string	The property key.	Role
Value	string	The property value.	Student
EnableAdminAccess	boolean	Mengaktifkan akses administrator.
PasswordExpireDays	integer
PasswordExpireRestDays	integer

Contoh

Respons sukses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "Test user.",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "用户组1"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "部门1",
          "OrgNamePath": ""
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "NickName": "李**",
      "RealNickName": "李**",
      "JobNumber": "A10000**",
      "Extras": {
        "AssignedResourceCount": {
          "key": "Desktop: 3"
        },
        "ResourcePolicyList": [
          {
            "PolicyId": "",
            "PolicyName": ""
          }
        ]
      },
      "ExternalName": "马**",
      "Properties": [
        {
          "Key": "Role",
          "Value": "Student"
        }
      ],
      "EnableAdminAccess": false,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.