Kueri anggota workspace menggunakan API QueryWorkspaceUserList - Quick BI - Alibaba Cloud - Quick BI

Mengkueri daftar anggota pada ruang kerja tertentu.

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:QueryWorkspaceUserList

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja.	95296e95-ca89-4c7d-8af9-dedf0ad0****
Keyword	string	No	Kata kunci untuk nama pengguna anggota ruang kerja.	分析
PageNum	integer	No	Nomor halaman saat ini daftar anggota ruang kerja: Nilai awal: 1 Nilai default: 1.	1
PageSize	integer	No	Jumlah baris per halaman dalam kueri terpaginasi: Nilai default: 10 Nilai maksimum: 1000.	10

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns the paginated result of the member list, with detailed information about the members stored in the Data parameter of the response.
Data	array<object>	Information about the workspace members.
	array<object>
AccountId	string	Alibaba Cloud account ID.	16020915****8429
AccountName	string	Alibaba Cloud account name.	pop****@aliyunid.test
NickName	string	Nickname.	我就是那个分析师大神
Role	object	Preset role information for the workspace member.
RoleCode	string	Code corresponding to the preset role.	role_workspace_admin
RoleId	integer	Preset role ID. Possible values: 25: Workspace Administrator 26: Workspace Developer 27: Workspace Analyst 30: Workspace Viewer	25
RoleName	string	Name of the preset role.	管理员
UserId	string	Quick BI user ID.	de4bc5f9429141cc8091cdd1c15b****
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page as set in the request.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "16020915****8429",
        "AccountName": "pop****@aliyunid.test",
        "NickName": "我就是那个分析师大神",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleId": 25,
          "RoleName": "管理员"
        },
        "UserId": "de4bc5f9429141cc8091cdd1c15b****"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	Workspace.Not.Exist	The group workspace does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.