Gunakan QueryWorksByWorkspace untuk query semua karya dalam workspace - Quick BI - Alibaba Cloud - Quick BI

Mengkueri semua karya di ruang kerja dalam suatu organisasi. Anda dapat menentukan tipe karya.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja.	89713491-cb4f-4579-b889-e82c35f1****
WorksType	string	No	Tipe karya. Nilai valid: DATAPRODUCT: Portal BI PAGE: Dasbor FULLPAGE: Dasbor layar penuh REPORT: Buku kerja.	PAGE
Status	integer	No	Status karya. Nilai valid: 0: Belum dipublikasikan 1: Dipublikasikan 2: Dimodifikasi tetapi belum dipublikasikan 3: Belum dipublikasikan.	0
ThirdPartAuthFlag	integer	No	Status penyematan pihak ketiga. Nilai valid: 0: Layanan penyematan tidak diaktifkan. 1: Penyematan diaktifkan.	0
PageNum	integer	No	Nomor halaman yang dikembalikan. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns a list of all works in the organization workspace that meet the requested criteria.
Data	array<object>	The details of the list of works.
	array<object>
Auth3rdFlag	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	1
Description	string	Remarks on the work.	备注
Directory	object	The directory to which the work belongs.
Id	string	The ID of the directory.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	The name of the directory.	所属目录名称。
PathId	string	The hierarchical structure of the directory ID to which the directory belongs. Separate the hierarchical structure with a /.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).	测试目录
GmtCreate	string	The timestamp of the creation of the work in milliseconds.	1496651577000
GmtModify	string	The timestamp of the modification of the work in milliseconds.	1572334870000
ModifyName	string	Nickname of the work modifier.	张三
OwnerId	string	The user ID of the work owner in the Quick BI.	作品所属工作空间名称。
OwnerName	string	The nickname of the work owner.	李四
PublicFlag	boolean	Is it public	true
PublicInvalidTime	integer	Deadline for the public release of the report	1721366354000
SecurityLevel	string	Security policies for collaborative authorization of works. Valid values: 0: private 12: Authorize specified members 1 or 11: Authorize all workspace members Catatan If you use legacy permissions, the return value is 1. If you use the new permissions, the return value is 11.	0
Status	integer	Status of dashboards, full-screen dashboards, spreadsheets. The default value of other work types is 1. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	1
WorkName	string	The name of the work.	测试报表
WorkType	string	The type of the work. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook dashboardOfflineQuery: self-service data retrieval Analysis: Ad hoc analysis DATAFORM: form filling	PAGE
WorksId	string	The ID of the work.	897ce25e-f993-4abd-af84-d13c5610****
WorkspaceId	string	The ID of the workspace to which the work belongs.	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	The name of the workspace to which the work belongs.	测试工作空间
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows in the table.	1
TotalPages	integer	The total number of pages returned.	1

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "备注",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "所属目录名称。",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "测试目录"
        },
        "GmtCreate": "1496651577000",
        "GmtModify": "1572334870000",
        "ModifyName": "张三",
        "OwnerId": "作品所属工作空间名称。",
        "OwnerName": "李四",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": "0",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
        "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.