Query semua karya dalam organisasi dengan QueryWorksByOrganization - Quick BI - Alibaba Cloud - Quick BI

Mengkueri semua karya di seluruh organisasi, dengan opsi untuk 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:QueryWorksByOrganization

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorksType	string	No	Tipe karya yang akan dikueri. Kosongkan untuk mengkueri semua tipe. Nilai yang mungkin: DATAPRODUCT: Portal Data PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Pengambilan Data Mandiri	PAGE
Status	integer	No	Status karya yang akan dikueri. Nilai yang mungkin: 0: Belum dipublikasikan 1: Dipublikasikan 2: Dimodifikasi tetapi belum dipublikasikan 3: Offline	0
ThirdPartAuthFlag	integer	No	Status penyematan pihak ketiga. Nilai yang mungkin: 0: Penyematan tidak diaktifkan 1: Penyematan diaktifkan	1
PageNum	integer	No	Nomor halaman. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah item per halaman. Nilai default adalah 10.	10

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang mungkin: true: Permintaan berhasil false: Permintaan gagal	true
RequestId	string	ID Permintaan.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Mengembalikan daftar semua karya di bawah organisasi yang memenuhi kriteria permintaan.
Data	array<object>	Detail daftar karya.
	array<object>
Auth3rdFlag	integer	Third-party embedding status. Possible values: 0: Embedding not enabled 1: Embedding enabled	1
Description	string	Notes for the work.	备注
Directory	object	Directory to which the work belongs.
Id	string	ID of the directory to which it belongs.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	Name of the directory to which it belongs.	测试目录
PathId	string	Hierarchical structure of the directory ID, separated by『/』.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	Hierarchical structure of the directory name, separated by『/』.	测试目录
GmtCreate	string	Timestamp (in milliseconds) when the work was created.	1496651577000
GmtModify	string	Millisecond-level timestamp of the work modification.	1572334870000
ModifyName	string	The Alibaba Cloud account name of the work modifier.	张三
OwnerId	string	The UserID of the work's owner in Quick BI.	作品所属工作空间名称。
OwnerName	string	The Alibaba Cloud account name of the work's owner.	李四
PublicFlag	boolean	Whether it is public	true
PublicInvalidTime	integer	The expiration date for the report to be made public	1721366354000
SecurityLevel	string	The security policy for collaborative authorization of the work. Values: 0: Private 12: Authorize specific members 1 or 11: Authorize all space members Catatan If you are using the old version of permissions, the returned value is 1. If you are using the new version of permissions, the returned value is 11.	1
Status	integer	The status of the report. Value range: 0: Unpublished 1: Published 2: Modified but not published 3: Offline	1
WorkName	string	The name of the work.	测试报表
WorkType	string	The type of the work. Value range: DATAPRODUCT: Data portal PAGE: Dashboard REPORT: Spreadsheet dashboardOfflineQuery: Self-service data retrieval	PAGE
WorksId	string	The ID of the work.	897ce25e-**--af84-d13c5610**
WorkspaceId	string	The ID of the workspace to which the work belongs.	作品修改者的阿里云账户名。
WorkspaceName	string	The name of the workspace to which the work belongs.	测试工作空间
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah baris per halaman yang ditetapkan saat meminta antarmuka.	10
TotalNum	integer	Jumlah total baris.	1
TotalPages	integer	Jumlah total halaman.	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": "1",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkspaceId": "作品修改者的阿里云账户名。",
        "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.