Gunakan ListCollections untuk mengambil karya favorit pengguna - Quick BI - Alibaba Cloud - Quick BI

Mengambil daftar karya yang difavoritkan pengguna.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
UserId	string	Yes	ID pengguna. Ini mengacu pada UserID di Quick BI, bukan UID Alibaba Cloud.	fe67f61a35a94b7da1a34ba174a7****

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	The primary key ID of the favorite record.	true
RequestId	string	Request ID.	162A632E-0A88-51CF-98F8-94FDEE82DB7D
Result	array<object>	Details of the list of reports favored by the user.
	object
FavoriteId	integer	The primary key ID of the favorite record.	12373
OwnerId	string	The user ID of the work owner. This refers to the UserID in Quick BI, not the Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****
WorksId	string	The ID of the work.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorksName	string	The name of the work.	奇异博士
WorksType	string	The type of the work. Possible values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet dataForm: Data Entry Form dashboardOfflineQuery: Self-service Data Extraction	dashboardOfflineQuery
WorkspaceId	string	Workspace ID.	9337d121-a78f-4c1b-a8bc-f81de117****
WorkspaceName	string	Workspace Name.	测试工作空间

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "162A632E-0A88-51CF-98F8-94FDEE82DB7D",
  "Result": [
    {
      "FavoriteId": 12373,
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****",
      "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "WorksName": "奇异博士",
      "WorksType": "dashboardOfflineQuery",
      "WorkspaceId": "9337d121-a78f-4c1b-a8bc-f81de117****",
      "WorkspaceName": "测试工作空间"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.