API ListFavoriteReports untuk mendaftar laporan favorit pengguna - Quick BI - Alibaba Cloud - Quick BI

Ikhtisar

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
UserId	string	Yes	ID pengguna di Quick BI yang akan dikueri.	b5d8fd9348cc4327****afb604
Keyword	string	No	Kata kunci nama karya.	财务报表
TreeType	string	No	Tipe karya yang akan dikueri (kosongkan untuk mengkueri semua tipe). Rentang nilai: DATAPRODUCT: Data Portal PAGE: Dasbor REPORT: Spreadsheet.	PAGE
PageSize	integer	No	Jumlah baris dalam daftar karya yang akan dikueri: Nilai default: 10 Nilai maksimum: 9999.	10

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns the query result.
Data	array<object>	List of works queried.
	object
Favorite	boolean	Indicates whether the user has favorited the work.	true
FavoriteDate	string	The timestamp when the work was favorited.	1640088615000
GmtCreate	string	Timestamp of the work creation.	1640088615000
GmtModified	string	Timestamp of the work modification.	1640595729000
HasEditAuth	boolean	Indicates whether the user has edit permission for the work.	true
HasViewAuth	boolean	Check if the user has the permission to view the work.	true
Name	string	Name of the work.	测试报表
OwnerName	string	Alibaba Cloud account name of the work owner.	luyaotest的昵称非管理员
OwnerNum	string	UserID of the work owner.	1365*****238860
PublishStatus	integer	Publication status of the work. Value range: 0: Not published 1: Published 2: Saved with modifications, not published 3: Offline	1
TreeId	string	Work ID.	977c7698-**--**-44b7304d20fc
Type	string	Type of the work. Value range: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet	PAGE
WorkspaceId	string	The ID of the workspace to which the work belongs.	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	The name of the workspace to which the work belongs.	测试工作空间
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page set when requesting the interface.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "FavoriteDate": "1640088615000",
        "GmtCreate": "1640088615000",
        "GmtModified": "1640595729000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "luyaotest的昵称非管理员",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.