Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (quickbi-public/2022-01-01) mematuhi standar RPC. Alibaba Cloud menyediakan SDK siap pakai untuk berbagai bahasa pemrograman populer guna mengabstraksi kompleksitas tingkat rendah seperti request signing. Hal ini memungkinkan developer untuk memanggil API menggunakan sintaks khusus tanpa perlu menangani detail HTTP secara langsung.
Signature kustom
Jika SDK tidak mendukung kebutuhan spesifik Anda, seperti signature kustom, Anda harus menandatangani request secara manual menggunakan signature mechanism. Perhatikan bahwa proses penandatanganan manual memerlukan upaya yang signifikan (estimasi 5 hari kerja). Untuk mendapatkan dukungan, bergabunglah dengan grup DingTalk kami (ID: 147535001692).
Sebelum Anda mulai
Akun Alibaba Cloud memiliki hak administratif penuh. Jika pasangan AccessKey dikompromikan, semua resource terkait dapat terekspos terhadap akses tidak sah, sehingga menimbulkan risiko keamanan yang signifikan. Buat Resource Access Management (RAM) user dengan akses khusus API dan gunakan kebijakan RAM untuk menerapkan principle of least privilege (PoLP). Gunakan akun Alibaba Cloud hanya jika benar-benar diperlukan.
Untuk memanggil API secara aman, konfigurasikan hal berikut:
Akun RAM user
Pasangan AccessKey untuk akun tersebut
Manajemen organisasi
|
API |
Judul |
Deskripsi |
| Manajemen pengguna organisasi | Manajemen pengguna organisasi | |
| DeleteUser | Delete Organization User | Menghapus pengguna organisasi tertentu. |
| CheckOrganizationMember | Periksa Anggota Organisasi | Memeriksa apakah pengguna adalah anggota organisasi. |
| AddUser | Tambah Anggota Organisasi | Menambahkan anggota organisasi. |
| BatchAddFeishuUsers | Menambahkan Pengguna Lark Secara Batch. | Menambahkan pengguna Lark secara batch. |
| UpdateUser | UpdateUser | Memperbarui informasi anggota tertentu dalam suatu organisasi. |
| QueryUserList | QueryUserList | Menampilkan daftar anggota organisasi. |
| QueryUserInfoByUserId | QueryUserInfoByUserId | Mengkueri informasi pengguna berdasarkan ID pengguna. |
| QueryUserInfoByAccount | Membuat Kelompok Pengguna | Membuat kelompok pengguna. Anda dapat menentukan kelompok pengguna induk. |
| Manajemen kelompok pengguna organisasi | Manajemen kelompok pengguna organisasi | |
| UpdateUserGroup | UpdateUserGroup | Memperbarui informasi tentang grup pengguna tertentu dalam suatu organisasi. |
| DeleteUserGroup | Menghapus Kelompok Pengguna | Menghapus kelompok pengguna di organisasi. |
| AddUserGroupMember | AddUserGroupMember | Menambahkan anggota organisasi ke kelompok pengguna tertentu. |
| AddUserGroupMembers | AddUserGroupMembers | Tambahkan pengguna ke grup pengguna yang ditentukan sekaligus. |
| DeleteUserGroupMember | DeleteUserGroupMember | Menghapus anggota tertentu dari grup pengguna tertentu. |
| DeleteUserGroupMembers | DeleteUserGroupMembers | Hapus secara massal pengguna yang ditentukan dari grup pengguna. |
| WithdrawAllUserGroups | WithdrawAllUserGroups | Membuat pengguna keluar dari semua grup pengguna. Proses ini tidak dapat dibatalkan. Lakukan operasi ini dengan hati-hati. |
| GetUserGroupInfo | Mendapatkan Informasi Kelompok Pengguna Berdasarkan Kata Kunci | Mencari informasi kelompok pengguna berdasarkan kata kunci nama kelompok pengguna. |
| ListByUserGroupId | ListByUserGroupId | Mengkueri informasi grup pengguna sekaligus berdasarkan ID grup pengguna. |
| ListUserGroupsByUserId | ListUserGroupsByUserId | Mengkueri semua kelompok pengguna tempat pengguna terdaftar berdasarkan ID pengguna. |
| QueryUserGroupListByParentId | QueryUserGroupListByParentId | Anda dapat menggunakan operasi ini untuk memperoleh informasi tentang grup pengguna anak di bawah grup pengguna induk tertentu. |
| QueryUserGroupMember | Kueri Daftar Anggota Grup Pengguna | Mengambil daftar anggota dalam suatu grup pengguna. |
| Manajemen tag pengguna | Manajemen tag pengguna | |
| AddUserTagMeta | Tambah Metadata Tag Anggota Organisasi | Menambahkan metadata tag anggota organisasi. |
| DeleteUserTagMeta | DeleteUserTagMeta | Menghapus metadata tag dari anggota organisasi. |
| UpdateUserTagValue | Memperbarui Nilai Tag Anggota Organisasi | Memperbarui nilai tag dari anggota organisasi. |
| QueryUserTagMetaList | QueryUserTagMetaList | Mengkueri daftar metadata tag anggota di organisasi. |
| QueryUserTagValueList | QueryUserTagValueList | Kueri daftar nilai tag pengguna tertentu. |
| UpdateUserTagMeta | UpdateUserTagMeta | Memperbarui metadata tag anggota organisasi. |
| Manajemen peran | Manajemen peran | |
| ListWorkspaceUserRolesByUserId | ListWorkspaceUserRolesByUserId | Mengambil semua peran ruang kerja milik seorang pengguna. |
| ListWorkspaceRoleUsers | ListWorkspaceRoleUsers | Mengambil daftar pengguna di bawah peran ruang kerja tertentu. |
| QueryWorkspaceRoleConfig | QueryWorkspaceRoleConfig | Mengambil informasi konfigurasi untuk peran ruang kerja tertentu. |
| QueryOrganizationRoleConfig | QueryOrganizationRoleConfig | Mendapatkan konfigurasi peran organisasi yang ditentukan. |
| ListWorkspaceRoles | ListWorkspaceRoles | Mengambil daftar peran ruang kerja. |
| ListOrganizationRoles | Dapatkan Daftar Peran Organisasi | Mengambil daftar peran kustom di tingkat organisasi. |
| ListOrganizationRoleUsers | Daftar Pengguna Peran Organisasi | Mengambil daftar pengguna di bawah peran organisasi tertentu. |
Pengelolaan izin
|
API |
Judul |
Deskripsi |
| Manajemen otorisasi berbagi laporan | Manajemen otorisasi berbagi laporan | |
| AddShareReport | Tambahkan konfigurasi berbagi karya data | Tambahkan konfigurasi berbagi untuk karya data. |
| CancelReportShare | CancelReportShare | Hapus otorisasi berbagi untuk karya data. |
| QuerySharesToUserList | QuerySharesToUserList | Mengkueri daftar karya yang diotorisasi kepada pengguna. |
| QueryShareList | Kueri Catatan Pembagian Karya | Kueri daftar objek tempat sebuah karya telah dibagikan, hanya mengembalikan konfigurasi pembagian yang masih dalam periode masa berlakunya. |
| AddWorksAuthorization | AddWorksAuthorization | Menambahkan otorisasi untuk sebuah work. |
| Manajemen otorisasi menu portal data | Manajemen otorisasi menu portal data | |
| AuthorizeMenu | AuthorizeMenu | Otorisasi batch menu portal BI akan dilewati secara otomatis. |
| CancelAuthorizationMenu | Membatalkan Otorisasi Menu Portal Data Secara Batch | Membatalkan catatan otorisasi untuk pengguna dan kelompok pengguna tertentu berdasarkan ID menu portal. |
| ChangeVisibilityModel | Ubah Model Visibilitas | Mengubah mode visibilitas menu BI portal dan menentukan apakah menu hanya dapat dilihat oleh pengguna yang diberi akses. |
| ListPortalMenus | ListPortalMenus | Mendapatkan daftar hierarkis menu di bawah portal BI tertentu. |
| ListPortalMenuAuthorization | Daftar Otorisasi Menu Portal | Mengambil daftar detail otorisasi untuk menu di portal BI. |
| ListWhitePortalMenu | ListWhitePortalMenu | Mendapatkan daftar putih untuk menu portal BI. |
| Manajemen izin tingkat baris | Manajemen izin tingkat baris | |
| SetDataLevelPermissionRuleConfig | Tetapkan Informasi Konfigurasi Izin Baris dan Kolom Kumpulan Data Tunggal | Tetapkan informasi konfigurasi izin baris dan kolom kumpulan data tunggal (penambahan dan pembaruan) |
| AddDataLevelPermissionRuleUsers | AddDataLevelPermissionRuleUsers | Menambahkan pengguna dan grup pengguna tertentu ke aturan izin tingkat baris. |
| AddDataLevelPermissionWhiteList | AddDataLevelPermissionWhiteList | Mengubah daftar putih (whitelist) untuk izin tingkat baris dan tingkat kolom dari dataset yang ditentukan. |
| DeleteDataLevelRuleConfig | Hapus Konfigurasi Aturan Izin Tingkat Baris | Menghapus aturan izin tingkat baris. |
| DeleteDataLevelPermissionRuleUsers | DeleteDataLevelPermissionRuleUsers | Menghapus pengguna tertentu dari aturan izin tingkat baris. |
| UpdateDataLevelPermissionStatus | UpdateDataLevelPermissionStatus | Memperbarui status izin tingkat baris dan tingkat kolom untuk set data. |
| SetDataLevelPermissionExtraConfig | SetDataLevelPermissionExtraConfig | Atur konfigurasi tambahan untuk izin baris dan kolom. |
| SetDataLevelPermissionWhiteList | SetDataLevelPermissionWhiteList | Menetapkan daftar putih untuk izin tingkat baris yang ditentukan. |
| QueryDatasetSwitchInfo | Informasi Sakelar Set Data | Mengambil status sakelar izin tingkat baris untuk set data tertentu. |
| ListCubeDataLevelPermissionConfig | Daftar Konfigurasi Izin Baris dan Kolom Set Data | Mengambil daftar konfigurasi izin baris dan kolom untuk set data tertentu. |
| ListDataLevelPermissionWhiteList | Dapatkan Daftar Putih Izin Baris dan Kolom Dataset | Ambil daftar putih (whitelist) untuk izin baris dan kolom dataset berdasarkan jenis izin. |
| Persetujuan terbuka | Persetujuan terbuka | |
| QueryApprovalInfo | QueryApprovalInfo | Mendapatkan informasi alur persetujuan berdasarkan penyetuju. |
| ResultCallback | ResultCallback | Anda dapat menyesuaikan antarmuka callback untuk proses persetujuan guna memproses proses persetujuan Quick BI. |
Manajemen sumber daya
|
API |
Judul |
Deskripsi |
| Manajemen resource laporan | Manajemen resource laporan | |
| UpdateEmbeddedStatus | UpdateEmbeddedStatus | Mengubah status penyematan laporan, mengaktifkan penyematan, atau menonaktifkan penyematan. |
| QueryWorksByOrganization | Kueri Semua Karya Di Bawah Organisasi | Mengkueri semua karya di seluruh organisasi, dengan opsi untuk menentukan tipe karya. |
| QueryWorksByWorkspace | QueryWorksByWorkspace | Mengkueri semua karya di ruang kerja dalam suatu organisasi. Anda dapat menentukan tipe karya. |
| QueryReadableResourcesListByUserIdV2 | Permintaan Daftar Karya yang Memiliki Izin untuk Dilihat Pengguna (Baru) | Permintaan daftar karya yang memiliki izin untuk dilihat pengguna (baru) |
| QueryReadableResourcesListByUserId | QueryReadableResourcesListByUserId | Mengkueri daftar karya yang memiliki izin Tampilan bagi pengguna, termasuk pernyataan yang diizinkan untuk dibagikan di ruang kerja. |
| CheckReadable | CheckReadable | Mengkueri apakah pengguna memiliki izin untuk Tampilan data works, seperti dashboard dan workbook. |
| QueryEmbeddedInfo | QueryEmbeddedInfo | Dapatkan konfigurasi penyematan dalam organisasi, termasuk jumlah maksimum penyematan dan jumlah penyematan. |
| QueryEmbeddedStatus | Status Penyematan | Mengkueri apakah penyematan diaktifkan untuk laporan. |
| QueryWorks | Query works | Mengkueri informasi tentang data work tertentu. |
| QueryWorksBloodRelationship | QueryWorksBloodRelationship | Mendapatkan hubungan ketergantungan data work, termasuk set data yang direferensikan oleh setiap komponen dan informasi bidang kueri. Saat ini, data work yang didukung hanya mencakup dashboard, workbook, dan layanan pengambilan data mandiri. |
| QueryComponentPerformance | QueryComponentPerformance | Mengkueri log performa komponen. |
| QueryReportPerformance | QueryReportPerformance | Menanyakan log kinerja laporan. |
| GetWorksEmbedList | Dapatkan Laporan yang Disematkan | Menanyakan daftar laporan yang disematkan |
| Manajemen resource set data | Manajemen resource set data | |
| UpdateDataSource | UpdateDataSource | Memodifikasi konfigurasi sumber data. |
| CreateDataset | CreateDataset | Membuat set data dari tabel fisik. |
| CheckDatasetExisted | CheckDatasetExisted | Memeriksa apakah dataset dengan CubeId yang ditentukan ada. |
| CreateCubeBySql | Membuat Set Data Berdasarkan SQL Kustom. | Membuat set data berdasarkan pernyataan SQL kustom. |
| AddDataSource | AddDataSource | Menambahkan sumber data. |
| UpdateCubeBySql | Memperbarui Set Data SQL Kustom. | Memperbarui set data SQL kustom. |
| QueryLastAccelerationEngineJob | Kueri Tugas Akselerasi Terbaru Berdasarkan ID Set Data | Mengkueri tugas akselerasi terbaru berdasarkan ID set data. |
| ListDataSource | ListDataSource | Kueri semua sumber data di bawah ruang kerja yang ditentukan |
| DataSetBlood | DataSetBlood | Mengkueri informasi karya di set data tertentu. |
| DataSourceBlood | Kueri informasi dataset di bawah sumber data yang ditentukan | Kueri informasi dataset di bawah sumber data yang ditentukan |
| ModifyApiDatasourceParameters | ModifyApiDatasourceParameters | Mengubah konfigurasi sumber data API tertentu. |
| ListApiDatasource | ListApiDatasource | Mengkueri sumber data API. |
| QueryDatasetInfo | QueryDatasetInfo | Apakah tabel merupakan tabel SQL kustom. Nilai valid: \* true: tabel SQL kustom \* false: tabel SQL non-kustom |
| QueryDatasetDetailInfo | QueryDatasetDetailInfo | Mengambil detail set data tertentu, termasuk sumber data, direktori, dan model set data. |
| QueryDatasetList | QueryDatasetList | Mengueri dataset di workspace yang ditentukan. Hasilnya diurutkan dalam urutan menurun berdasarkan waktu pembuatan. |
| AllotDatasetAccelerationTask | Tugas Akselerasi Set Data | Memicu akselerasi koleksi mesin Quick untuk set data. |
| QueryCubePerformance | QueryCubePerformance | Mengkueri log performa set data. |
| QueryCubeOptimization | QueryCubeOptimization | Mengambil saran pengoptimalan dataset. |
| GetDataSourceConnectionInfo | Dapatkan Informasi Koneksi Sumber Data | Mengambil informasi koneksi sumber data. |
| ListAccelerationOfWorkspace | ListAccelerationOfWorkspace | Mengambil informasi tentang tugas akselerasi di ruang kerja. |
| QueryAccelerationLogByCubeId | QueryAccelerationLogByCubeId | Menanyakan log eksekusi tugas akselerasi untuk dataset tertentu. |
| Manajemen ruang kerja | Manajemen ruang kerja | |
| CreateWorkspace | CreateWorkspace | Membuat ruang kerja. |
| AddUserToWorkspace | Tambah Anggota ke Ruang Kerja | Menambahkan anggota ke ruang kerja tertentu. |
| AddWorkspaceUsers | Menambahkan Anggota ke Ruang Kerja Secara Batch | Menambahkan anggota ke ruang kerja secara batch. |
| DeleteUserFromWorkspace | Hapus Anggota Ruang Kerja | Hapus anggota dari ruang kerja yang ditentukan. |
| UpdateWorkspaceUsersRole | Pembaruan Batch Peran Anggota Ruang Kerja | Memperbarui informasi peran anggota ruang kerja secara batch. Peran yang ada akan ditimpa. |
| UpdateWorkspaceUserRole | Ubah Peran Anggota Ruang Kerja | Mengubah peran anggota tertentu di ruang kerja, peran yang ada akan ditimpa. |
| QueryWorkspaceUserList | Daftar Anggota pada Ruang Kerja | Mengkueri daftar anggota pada ruang kerja tertentu. |
| QueryOrganizationWorkspaceList | Dapatkan Daftar Ruang Kerja di Bawah Organisasi | Mencantumkan ruang kerja di organisasi saat ini. |
| QueryUserRoleInfoInWorkspace | Kueri Peran Preset Anggota Ruang Kerja | Dapatkan informasi peran ruang kerja preset untuk anggota ruang kerja tertentu. |
| Manajemen favorit | Manajemen favorit | |
| SaveFavorites | Tambahkan Karya ke Favorit | Menambahkan karya ke favorit pengguna. |
| CancelCollection | CancelCollection | Batalkan karya data dari koleksi pengguna. |
| Manajemen beranda | Manajemen beranda | |
| ListCollections | ListCollections | Mengambil daftar karya yang difavoritkan pengguna. |
| ListFavoriteReports | Daftar Laporan Favorit di Dasbor Beranda | Ikhtisar |
| ListRecentViewReports | ListRecentViewReports | Anda dapat memanggil operasi ini untuk mendapatkan daftar yang paling sering dilihat dan jejak langkah yang ditampilkan di dasbor beranda untuk pengguna tertentu. |
| ListSharedReports | ListSharedReports | Anda dapat menggunakan operasi ini untuk mendapatkan daftar karya yang diotorisasi yang ditampilkan di halaman beranda pengguna tertentu. |
| Manajemen langganan | Manajemen langganan | |
| ManualRunMailTask | ManualRunMailTask | Jalankan Tugas Email Secara Manual |
| GetMailTaskStatus | GetMailTaskStatus | Periksa status berjalan tugas email dalam suatu organisasi |
| GetMailTaskList | GetMailTaskList | Mengambil daftar tugas pelacakan. Catatan: Jika AccessKey (AK) pemanggil tidak memiliki izin untuk melihat tugas pelacakan pengguna lain, operasi ini hanya mengembalikan tugas yang berhak diakses oleh pemanggil. |
Manajemen data
|
API |
Judul |
Deskripsi |
| Layanan data | Layanan data | |
| QueryData | QueryData | Memanggil API Studio Layanan Data untuk mengkueri data. |
| QueryDataServiceList | QueryDataServiceList | Daftar API Layanan Data Kueri |
| QueryDataService | Memanggil API Layanan Data | Memanggil API yang telah dibuat di layanan data. |
Analitik tertanam
|
API |
Judul |
Deskripsi |
| Penyematan laporan | Penyematan laporan | |
| CreateTicket | Menghasilkan Tiket Laporan Tertanam. | Menghasilkan tiket yang diperlukan untuk akses laporan tertanam. |
| DeleteTicket | Hapus Tiket Tertanam | Menghapus tiket tertanam pihak ketiga. |
| DelayTicketExpireTime | DelayTicketExpireTime | Memperbarui waktu kedaluwarsa tiket yang disematkan dalam laporan. |
| UpdateTicketNum | UpdateTicketNum | Perbarui jumlah tiket pada tiket tertentu yang digunakan untuk laporan tersemat pembebasan. |
| QueryTicketInfo | Kueri Informasi Tiket | Mengambil detail tiket tertentu untuk laporan yang tidak disematkan. |
Analisis statistik
|
API |
Judul |
Deskripsi |
| Analisis resource | Analisis resource | |
| QueryAuditLog | Kueri Informasi Log Audit | Mengkueri informasi log audit. |
Tanya jawab cerdas
|
API |
Judul |
Deskripsi |
| Penyematan tanya jawab cerdas | Penyematan tanya jawab cerdas | |
| CreateTicket4Copilot | Hasilkan Tiket Penyematan Smart Q | Menghasilkan tiket untuk menyematkan Copilot. |
| ModifyCopilotEmbedConfig | Modify Intelligent Query Embedding Configuration | Mengubah konfigurasi penyematan kueri cerdas. |
| QueryCopilotEmbedConfig | Dapatkan Daftar Konfigurasi untuk Mengaktifkan Embedding XiaoQ | Dapatkan Daftar Konfigurasi untuk Mengaktifkan Embedding XiaoQ |
| QueryDataRange | Get Data Range Catalog List | Mengambil daftar katalog rentang data. |
| Manajemen tanya jawab cerdas | Manajemen tanya jawab cerdas | |
| ModifyDashboardNl2sqlStatus | Mengubah Status Q-Assistant untuk Dasbor | Mengubah status Q-Assistant untuk beberapa dasbor. |
| QueryDashboardNl2sql | QueryDashboardNl2sql | Mengkueri Informasi Sumber Daya Pertanyaan Dashboard |
| SmartqAuthorize | Manajemen Massal Otorisasi Q\\\\\\&A Cerdas | Mengelola otorisasi untuk Tanya Jawab Cerdas (Q&A) secara massal. |
| QueryLlmCubeWithThemeListByUserId | Periksa dataset dan tema analisis mana yang memiliki otorisasi tanya jawab oleh pengguna | Periksa dataset dan tema analisis mana yang memiliki otorisasi tanya jawab oleh pengguna |
| SmartqAuthTransfer | Sinkronkan izin jumlah pertanyaan pengguna tertentu ke pengguna lain | Sinkronkan izin jumlah pertanyaan pengguna tertentu ke pengguna lain |
| QuerySmartqPermissionByCubeId | Periksa izin pengguna untuk dataset Smart Q&A | Mengkueri izin pengguna pada dataset Smart Q&A. |
| QueryDatasetSmartqStatus | Periksa Apakah Kumpulan Data Telah Mengaktifkan Kueri Cerdas | Memeriksa apakah Tanya Jawab Cerdas diaktifkan untuk suatu kumpulan data. |
| SmartqQueryAbility | Smart Query | Menjalankan kueri tanya jawab cerdas. |
Lainnya
|
API |
Judul |
Deskripsi |
| ClearDynamicTagCache | Hapus cache dari tag dinamis tertentu. | Menghapus nilai tag yang di-cache untuk satu konfigurasi. |
| CreateUserGroup | CreateUserGroup | Create a user group. You can specify a parent user group. |
| DeleteAuthorizationByUserId | Menghapus catatan otorisasi kolaboratif pengguna tertentu. | Menghapus catatan otorisasi kolaboratif pengguna tertentu. |
| IpWhiteListConfig | Konfigurasi Daftar Putih IP untuk Keamanan Data. | Mengonfigurasi daftar putih alamat IP untuk keamanan data. |
| ListDynamicTag | Mengambil daftar label dinamis untuk organisasi saat ini. | Mengambil daftar label dinamis untuk organisasi saat ini. |
| QueryUserByMobileAccount | Mengkueri UserId Berdasarkan ID Akun Pihak Ketiga Yang Terikat. | Mengkueri UserId berdasarkan ID akun pihak ketiga yang terikat. |
| TransferUsergroup | Memigrasikan Kelompok Pengguna. | Memigrasikan kelompok pengguna. |