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 | Memeriksa Apakah Pengguna Termasuk dalam Organisasi | Memeriksa apakah pengguna termasuk dalam organisasi. |
| AddUser | Menambahkan Anggota Organisasi. | Menambahkan anggota organisasi. |
| BatchAddFeishuUsers | Menambahkan Beberapa Pengguna Lark | Menambahkan beberapa pengguna Lark. |
| UpdateUser | Pembaruan Informasi Anggota Organisasi. | Memperbarui informasi anggota tertentu dalam organisasi. |
| QueryUserList | Kueri Daftar Anggota Organisasi | Mengkueri daftar anggota organisasi. |
| QueryUserInfoByUserId | Kueri informasi pengguna berdasarkan ID pengguna. | Mengkueri informasi pengguna berdasarkan ID pengguna. |
| QueryUserInfoByAccount | Kueri informasi pengguna berdasarkan akun. | Mengkueri informasi pengguna berdasarkan ID Alibaba Cloud atau nama akun Alibaba Cloud. |
| QueryUserByMobileAccount | Mengkueri ID Pengguna Berdasarkan ID Akun Pihak Ketiga yang Terikat | Mengkueri ID pengguna berdasarkan ID akun pihak ketiga yang terikat. |
| Manajemen grup pengguna organisasi | Manajemen grup pengguna organisasi | |
| UpdateUserGroup | UpdateUserGroup | Memperbarui informasi tentang grup pengguna tertentu dalam suatu organisasi. |
| DeleteUserGroup | Menghapus Kelompok Pengguna | Menghapus kelompok pengguna di organisasi. |
| CreateUserGroup | CreateUserGroup | Membuat kelompok pengguna. Anda dapat menentukan kelompok pengguna induk. |
| AddUserGroupMember | Menambahkan Anggota ke Kelompok Pengguna | Menambahkan anggota organisasi ke kelompok pengguna tertentu. |
| AddUserGroupMembers | Menambahkan beberapa anggota ke kelompok pengguna | Menambahkan beberapa pengguna ke kelompok pengguna tertentu. |
| 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 | Mengambil Informasi Kelompok Pengguna Berdasarkan Kata Kunci. | Mencari informasi kelompok pengguna berdasarkan kata kunci nama kelompok pengguna. |
| ListByUserGroupId | Mengkueri Kelompok Pengguna Secara Batch. | Mengkueri informasi tentang kelompok pengguna secara batch berdasarkan ID kelompok 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 | Daftar Anggota Kelompok Pengguna | Mengambil daftar anggota dalam kelompok pengguna. |
| TransferUsergroup | Memigrasikan Kelompok Pengguna. | Memigrasikan kelompok pengguna. |
| Manajemen tag pengguna | Manajemen tag pengguna | |
| AddUserTagMeta | Membuat Metadata untuk Tag Anggota Organisasi | Membuat metadata untuk 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 | Perbarui Metadata Tag Anggota Organisasi. | Memperbarui metadata tag anggota organisasi. |
| ListDynamicTag | Mengambil daftar label dinamis untuk organisasi saat ini. | Mengambil daftar label dinamis untuk organisasi saat ini. |
| ClearDynamicTagCache | Hapus Cache untuk Tag Dinamis Tertentu | Menghapus cache nilai tag untuk satu konfigurasi. |
| 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 kontrol akses | Manajemen kontrol akses | |
| IpWhiteListConfig | Mengonfigurasi Daftar Putih IP untuk Keamanan Data. | Mengonfigurasi daftar putih IP untuk keamanan data. |
| Manajemen otorisasi berbagi laporan | Manajemen otorisasi berbagi laporan | |
| UpdateAuthorizationAttributes | Mengubah Atribut Izin Otorisasi Kolaboratif Resource. | Mengubah atribut izin otorisasi kolaboratif sumber daya. |
| ListAuthConfigByResource | Mengkueri Catatan Otorisasi Kolaboratif Sumber Daya. | Mengkueri catatan otorisasi kolaboratif sumber daya. |
| AddShareReport | Menambahkan Konfigurasi Berbagi untuk Sebuah Karya Data. | Menambahkan konfigurasi berbagi untuk sebuah karya data. |
| CancelReportShare | Hapus Otorisasi Berbagi untuk Data Work | Menghapus otorisasi berbagi untuk data work. |
| 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 | Membuat catatan otorisasi kolaboratif untuk sumber daya | Membuat catatan otorisasi kolaboratif untuk sumber daya. |
| DeleteAuthorizationByUserId | Menghapus catatan otorisasi kolaboratif pengguna tertentu. | Menghapus catatan otorisasi kolaboratif pengguna tertentu. |
| Manajemen otorisasi menu portal data | Manajemen otorisasi menu portal data | |
| AuthorizeMenu | Memberikan Izin Batch untuk Menu Data Portal | Memberikan izin batch untuk menu data portal. Menu yang sudah diberikan izin akan dilewati secara otomatis. |
| CancelAuthorizationMenu | Mencabut Otorisasi Menu Portal Data Secara Batch | Mencabut 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 | Menambahkan Pengguna dan Kelompok Pengguna ke Aturan Izin Baris-Kolom | Menambahkan pengguna dan kelompok pengguna tertentu ke aturan izin baris-kolom tertentu. |
| AddDataLevelPermissionWhiteList | Pembaruan Bertahap Daftar Putih untuk Izin Baris dan Kolom | Mengubah daftar putih untuk izin baris dan kolom dari set data tertentu. |
| 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 | Mengambil Status Sakelar Izin Tingkat Baris 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 | Daftar Putih Izin Baris dan Kolom Set Data. | Mengambil daftar putih izin tingkat baris atau tingkat kolom untuk set data berdasarkan tipe izin yang ditentukan. |
| Persetujuan terbuka | Persetujuan terbuka | |
| QueryApprovalInfo | Mengambil Informasi Alur Persetujuan Berdasarkan Penyetuju | Mengambil 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 sumber daya laporan | Manajemen sumber daya laporan | |
| UpdateEmbeddedStatus | UpdateEmbeddedStatus | Mengubah status penyematan laporan, mengaktifkan penyematan, atau menonaktifkan penyematan. |
| QueryWorksByOrganization | Mengkueri Semua Work dalam Sebuah Organisasi | Mengkueri semua work dalam sebuah organisasi. Anda dapat menentukan tipe work. |
| 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 | Mengambil Detail Data Work | Mengkueri detail data work tertentu. |
| QueryWorksBloodRelationship | Lineage Data Work | Mengambil lineage data work, termasuk set data yang direferensikan oleh setiap komponen dan informasi bidang kueri. Saat ini, hanya dashboard, workbook, dan kueri ad hoc yang didukung. |
| QueryComponentPerformance | Kueri Log Performa Komponen | Mengkueri log performa komponen. |
| QueryReportPerformance | Kueri Log Kinerja Laporan | Mengkueri log kinerja laporan. |
| GetWorksEmbedList | Mengambil laporan yang disematkan | Mengkueri daftar laporan yang disematkan. |
| Manajemen sumber daya set data | Manajemen sumber daya 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 | Membuat Koneksi Sumber Data | Membuat koneksi 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 | Kueri Daftar Sumber Data API. | Mengkueri daftar sumber data API. |
| QueryDatasetInfo | Kueri Informasi Set Data | Mengkueri informasi set data tertentu. |
| QueryDatasetDetailInfo | Kueri Detail Set Data | Mengkueri detail set data tertentu, termasuk sumber data, folder, dan model set data yang terkait. |
| QueryDatasetList | Kueri Daftar Set Data Ruang Kerja. | Mengkueri daftar set data di ruang kerja tertentu, diurutkan berdasarkan pengatur waktu pembuatan dalam Pesanan menurun. |
| AllotDatasetAccelerationTask | Memicu akselerasi ekstraksi set data | Memicu akselerasi ekstraksi Quick engine untuk set data. |
| QueryCubePerformance | Mengkueri Log Performa Set Data | Mengkueri log performa set data. |
| QueryCubeOptimization | Mengkueri Saran Optimasi Set Data | Mengkueri saran optimasi untuk set data. |
| GetDataSourceConnectionInfo | Dapatkan Informasi Koneksi Sumber Data | Mengambil informasi koneksi sumber data. |
| ListAccelerationOfWorkspace | Mengambil Informasi Tugas Mesin Akselerasi di Ruang Kerja. | Mengambil informasi tugas mesin akselerasi dari halaman manajemen ruang kerja. |
| QueryAccelerationLogByCubeId | Mengambil log eksekusi tugas akselerasi untuk set data tertentu | Mengambil log eksekusi tugas akselerasi untuk set data tertentu. |
| Manajemen ruang kerja | Manajemen ruang kerja | |
| CreateWorkspace | CreateWorkspace | Membuat ruang kerja. |
| AddUserToWorkspace | Menambahkan 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 | Memperbarui Peran Anggota Ruang Kerja Secara Batch. | Memperbarui peran anggota ruang kerja secara batch. Peran yang ada akan ditimpa. |
| UpdateWorkspaceUserRole | Mengubah 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 | Daftar ruang kerja di organisasi. | Mengkueri daftar 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 | Menghapus Karya dari Favorit | Menghapus karya data dari favorit pengguna. |
| Manajemen beranda | Manajemen beranda | |
| ListCollections | ListCollections | Mengambil daftar karya yang difavoritkan pengguna. |
| ListFavoriteReports | Daftar Laporan Favorit di Dasbor Beranda | Ikhtisar |
| ListRecentViewReports | Item yang Sering Dilihat dan Daftar Jejak pada Dasbor Beranda. | Mengambil tampilan yang sering dilihat dan daftar jejak yang ditampilkan pada 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 dibuat di Data Service. |
Analisis 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 | Mengkueri detail tiket laporan tertanam. | Mengambil detail tiket tertentu untuk laporan tertanam tanpa login. |
Analisis statistik
|
API |
Judul |
Deskripsi |
| Analisis sumber daya | Analisis sumber daya | |
| QueryAuditLog | Mengkueri 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 | Mengkueri Informasi Sumber Daya NL2SQL Dasbor | Mengkueri informasi sumber daya NL2SQL dasbor. |
| 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 | Kueri Smart Q&A. | Mengkueri data dengan menggunakan fitur Smart Q&A. |