Gunakan QueryUserList untuk mengambil daftar anggota organisasi - Quick BI - Alibaba Cloud - Quick BI

Menampilkan daftar anggota organisasi.

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

quickbi-public:QueryUserList

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Keyword	string	No	Kata kunci untuk mencari anggota organisasi berdasarkan nama pengguna atau nama panggilan.	test
PageNum	integer	No	Nomor halaman yang akan dikembalikan. Nilai awal: 1 Nilai default: 1.	1
PageSize	integer	No	Jumlah anggota organisasi yang akan dikembalikan per halaman. Nilai default: 10 Nilai maksimum: 1000.	10

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The paginated list of users. The `Data` parameter contains the details of each organization member.
Data	array<object>	The list of users.
	object	The details of a user.
AccountId	string	The ID of the Alibaba Cloud account. If a user is not added by using a RAM user, the Alibaba Cloud ID of the user is returned only after the user logs on to the Quick BI console for the first time.	1355********
AccountName	string	The name of the Alibaba Cloud account.	test
AdminUser	boolean	Indicates whether the user is an organization administrator. Valid values: `true`: yes `false`: no Penting This parameter is deprecated. We recommend that you use the RoleIdList parameter.	true
AuthAdminUser	boolean	Indicates whether the user is a permission administrator. Valid values: `true`: yes `false`: no Penting This parameter is deprecated. We recommend that you use the RoleIdList parameter.	true
JoinedDate	integer	The time when the user joined the organization.	1718691704000
LastLoginTime	integer	The time when the user last logged on.	1718761320681
NickName	string	The nickname of the organization member.	test
RoleIdList	array	The list of IDs of the roles that are assigned to the user in the organization.
	integer	The ID of the role in the organization. A maximum of three roles can be returned, including but not limited to the following built-in roles in the organization: Organization administrator (built-in role): 111111111 Permission administrator (built-in role): 111111112 Standard user (built-in role): 111111113	111111111
UserId	string	The user ID in Quick BI.	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	The user type of the organization member. Valid values: `1`: developer `2`: visitor `3`: analyst	1
IsDeleted	boolean	The status of the user. Valid values: `false`: active `true`: inactive	false
CopilotModules	array
	string
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of matching users.	1
TotalPages	integer	The total number of pages.	1

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "1355********",
        "AccountName": "test",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "test",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false,
        "CopilotModules": [
          "qreport "
        ]
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.