Versi SDK yang disediakan oleh Quick BI - Quick BI

Topik ini menjelaskan versi kit pengembangan perangkat lunak (SDK) yang disediakan oleh Quick BI dan cara memperoleh versi terbarunya.

Ikhtisar SDK

Pendahuluan

SDK Quick BI untuk analitik visual menyediakan serangkaian operasi API yang telah dienkapsulasi. SDK ini menggunakan pasangan Kunci Akses (AccessKey pair) untuk verifikasi identitas dan menawarkan fitur seperti penandatanganan otomatis guna menyederhanakan pembuatan dan manajemen sumber daya.

Kit pengembangan perangkat lunak (SDK) Quick BI untuk analitik visual mengenkapsulasi operasi API. SDK ini menggunakan pasangan AccessKey untuk mengidentifikasi pemanggil dan menyediakan fitur seperti penandatanganan otomatis untuk membantu Anda membuat dan mengelola sumber daya. Untuk menggunakan fitur analitik visual Quick BI, Anda harus menginstal SDK Quick BI dan pustaka inti Alibaba Cloud. Misalnya, jika Anda menggunakan Java SDK, Anda harus mengunduh aliyun-java-sdk-core dan aliyun-java-sdk-quickbi-public.

Catatan

Buka halaman Alibaba Cloud SDK untuk mengunduh SDK dan melihat petunjuk penggunaannya.
Untuk daftar operasi API yang tersedia, lihat Referensi API.
Dapatkan ID AccessKey dan Rahasia AccessKey untuk akun Alibaba Cloud Anda.
Untuk informasi selengkapnya, lihat Buat Pasangan AccessKey.
Untuk memanggil operasi API menggunakan SDK, Anda harus memenuhi dua kondisi berikut:
- Anda telah masuk ke Quick BI dengan akun Alibaba Cloud Anda setidaknya satu kali.
- Akun Alibaba Cloud Anda diberikan peran administrator organisasi di Quick BI. Administrator juga dapat memberikan izin kepada pengguna non-administrator untuk memanggil semua operasi API pada halaman Open Platform. Untuk informasi selengkapnya, lihat Ikhtisar > Pengendalian akses.

Bahasa pemrograman yang didukung

Quick BI mendukung pengembangan menggunakan kit pengembangan perangkat lunak (SDK) dalam bahasa seperti Java, Python, dan C#. Untuk informasi selengkapnya tentang SDK tersebut, kunjungi Alibaba Cloud Open Platform.

Panduan versi

Versi yang Dirilis	Waktu rilis	Deskripsi perubahan
2.0.0	2022-03-04	API V2 dirilis dengan titik akhir khusus wilayah. Operasi yang dirilis mencakup semua operasi dari daftar API asli. Catatan Daftar API asli tidak lagi dipelihara setelah rilis API V2. Semua operasi API baru ditambahkan ke V2.

Tautan terkait

Pusat Pengembang Alibaba Cloud menyediakan SDK untuk bahasa pemrograman yang sering digunakan. Pusat ini juga menyediakan informasi seperti tutorial mulai cepat dan daftar proyek sumber terbuka. Untuk informasi selengkapnya, lihat Pusat Pengembang Alibaba Cloud.

Metode pemanggilan SDK

Saat memanggil SDK, perhatikan hal-hal berikut:

Buat dan inisialisasi instance DefaultAcsClient menggunakan ID AccessKey dan Rahasia AccessKey yang sesuai dengan akun Alibaba Cloud Anda. Jika tidak, kesalahan berikut akan dilaporkan: code: 404, Specified access key is not found. request id: AA7FE476-F206-5C52-95B3-DF35CD30D468.
Pasangan AccessKey harus milik akun Alibaba Cloud yang diberikan peran administrator organisasi di Quick BI dan telah digunakan untuk masuk ke Quick BI setidaknya satu kali. Tentukan pasangan AccessKey sesuai kebutuhan.

Untuk informasi selengkapnya tentang cara memanggil SDK, lihat dokumentasi SDK.

Pengendalian aliran operasi API

Penting

Versi operasi API berikut adalah 2022-01-01.
Pengguna Quick BI yang diterapkan di cloud publik dan Cloud Keuangan dapat memanggil operasi API berikut.
Hanya edisi Quick BI Professional dan yang lebih tinggi yang mendukung pemanggilan API.

Kategori	Nama API	Deskripsi	QPS (permintaan/detik)	Timeout (detik)
Manajemen organisasi dan pengguna	AddUser	Menambahkan anggota ke organisasi.	50	10
	UpdateUser	Memperbarui informasi anggota tertentu dalam organisasi.	50	10
	QueryUserList	Menanyakan daftar anggota dalam organisasi.	30	10
	DeleteUser	Menghapus pengguna tertentu dari organisasi.	50	10
	QueryUserInfoByUserId	Menanyakan informasi anggota dalam organisasi berdasarkan ID pengguna.	30	10
	QueryUserInfoByAccount	Menanyakan informasi anggota dalam organisasi berdasarkan ID akun Alibaba Cloud atau nama.	30	10
Manajemen tag pengguna	AddUserTagMeta	Menambahkan metadata untuk tag anggota dalam organisasi.	50	10
	DeleteUserTagMeta	Menghapus metadata tag anggota dalam organisasi.	50	10
	QueryUserTagMetaList	Menanyakan daftar metadata tag anggota dalam organisasi.	30	10
	UpdateUserTagValue	Mengubah nilai tag anggota dalam organisasi.	50	10
	QueryUserTagValueList	Menanyakan daftar nilai tag untuk pengguna tertentu.	30	10
	UpdateUserTagMeta	Memperbarui metadata tag anggota dalam organisasi.	50	10
Manajemen organisasi dan grup pengguna	AddUserGroupMember	Menambahkan anggota organisasi ke grup pengguna tertentu.	50	10
	AddUserGroupMembers	Menambahkan beberapa pengguna ke grup pengguna tertentu secara batch.	50	10
	DeleteUserGroupMember	Menghapus anggota tertentu dari grup pengguna tertentu.	50	10
	CreateUserGroup	Membuat grup pengguna dalam organisasi tertentu.	50	10
	DeleteUserGroup	Menghapus grup pengguna dari organisasi tertentu.	50	10
	UpdateUserGroup	Memperbarui informasi grup pengguna tertentu dalam organisasi.	50	10
	QueryUserGroupMember	Menanyakan daftar anggota dalam grup pengguna.	30	10
	QueryUserGroupListByParentId	Menanyakan informasi tentang grup pengguna anak dari grup pengguna induk tertentu.	30	10
	GetUserGroupInfo	Mencari grup pengguna berdasarkan kata kunci nama grup pengguna.	30	10
	ListUserGroupsByUserId	Menanyakan daftar grup pengguna tempat pengguna tergabung.	30	10
	WithdrawAllUserGroups	Menghapus pengguna dari semua grup pengguna.	50	10
	DeleteUserGroupMembers	Menghapus beberapa pengguna dari grup pengguna secara batch.	50	10
	ListByUserGroupId	Menanyakan informasi beberapa grup pengguna sekaligus berdasarkan ID grup pengguna.	50	10
Pembagian laporan dan otorisasi	QueryShareList	Menanyakan daftar otorisasi.	30	10
	AddShareReport	Menambahkan kebijakan otorisasi ke laporan.	50	10
	QuerySharesToUserList	Menanyakan daftar karya yang diotorisasi kepada pengguna.	30	10
	CancelReportShare	Menghapus kebijakan otorisasi laporan.	50	10
Otorisasi menu Portal BI	ListPortalMenus	Menanyakan daftar menu Portal BI.	30	10
	ListPortalMenuAuthorization	Menanyakan daftar otorisasi menu Portal BI.	30	10
	AuthorizeMenu	Menambahkan otorisasi ke menu Portal BI secara batch.	50	10
	CancelAuthorizationMenu	Membatalkan otorisasi menu Portal BI secara batch.	50	10
	ChangeVisibilityModel	Memodifikasi visibilitas menu Portal BI. Anda dapat mengatur agar menu hanya terlihat oleh pengguna yang diotorisasi.	50	10
Pengelolaan izin tingkat baris	QueryDatasetSwitchInfo	Menanyakan status sakelar izin tingkat baris untuk set data.	30	10
	UpdateDataLevelPermissionStatus	Mengaktifkan atau menonaktifkan izin tingkat baris dan kolom untuk set data.	50	10
	ListCubeDataLevelPermissionConfig	Menanyakan konfigurasi izin tingkat baris dan kolom untuk set data.	30	10
	SetDataLevelPermissionRuleConfig	Mengonfigurasi aturan untuk izin tingkat baris dan kolom pada set data.	50	10
	DeleteDataLevelRuleConfig	Menghapus aturan untuk izin tingkat baris dan kolom pada set data.	50	10
	AddDataLevelPermissionRuleUsers	Menambahkan pengguna yang diberikan izin tingkat baris berdasarkan aturan secara inkremental.	50	10
	DeleteDataLevelPermissionRuleUsers	Menghapus pengguna yang diberikan izin tingkat baris berdasarkan aturan.	50	10
	SetDataLevelPermissionExtraConfig	Menentukan konfigurasi tambahan untuk izin tingkat baris atau kolom.	50	10
	ListDataLevelPermissionWhiteList	Menanyakan daftar putih untuk izin tingkat baris dan kolom pada set data.	30	10
	SetDataLevelPermissionWhiteList	Mengonfigurasi daftar putih untuk izin tingkat baris dan kolom.	50	10
	AddDataLevelPermissionWhiteList	Mengonfigurasi daftar putih untuk izin tingkat baris dan kolom secara inkremental.	50	10
Manajemen Ruang Kerja	UpdateWorkspaceUsersRole	Mengubah peran anggota dalam ruang kerja.	50	10
	QueryWorkspaceUserList	Menanyakan daftar anggota dalam ruang kerja tertentu.	30	10
	DeleteUserFromWorkspace	Menghapus anggota dari ruang kerja tertentu.	50	10
	QueryOrganizationWorkspaceList	Menanyakan daftar ruang kerja dalam organisasi saat ini.	30	10
	AddUserToWorkspace	Menambahkan anggota ke ruang kerja tertentu.	50	10
	AddWorkspaceUsers	Menambahkan beberapa anggota ke ruang kerja tertentu secara batch.	50	10
	QueryUserRoleInfoInWorkspace	Menanyakan informasi peran anggota dalam ruang kerja tertentu.	30	10
	UpdateWorkspaceUserRole	Memperbarui informasi peran anggota dalam ruang kerja secara batch.	50	10
Manajemen sumber daya laporan	QueryWorksByOrganization	Menanyakan daftar laporan dalam organisasi.	30	10
	QueryWorksByWorkspace	Menanyakan daftar laporan dalam ruang kerja tertentu organisasi.	30	10
	QueryReadableResourcesListByUserId	Menanyakan daftar laporan yang memiliki izin untuk dilihat pengguna.	30	10
	CheckReadable	Memeriksa apakah pengguna memiliki izin untuk melihat laporan.	50	10
	QueryEmbeddedInfo	Menanyakan informasi penyematan laporan dalam organisasi.	30	10
	UpdateEmbeddedStatus	Mengubah status penyematan laporan.	50	10
	QueryWorks	Menanyakan informasi laporan.	30	10
	QueryWorksBloodRelationship	Menanyakan alur data laporan tertentu.	30	10
Manajemen sumber daya dataset	QueryDatasetList	Menanyakan daftar set data dalam ruang kerja tertentu.	30	10
	QueryDatasetDetailInfo	Menanyakan detail set data tertentu.	30	10
	QueryDatasetInfo	Menanyakan detail set data.	30	10
Manajemen Favorit	ListCollections	Menanyakan daftar favorit.	30	10
	SaveFavorites	Menambahkan karya ke favorit.	50	10
	CancelCollection	Menghapus karya dari favorit.	50	10
Manajemen halaman utama	ListFavoriteReports	Menanyakan daftar karya yang diotorisasi pada halaman Dasbor Saya untuk pengguna tertentu.	30	10
	ListSharedReports	Menanyakan daftar karya favorit pada halaman Dasbor Saya untuk pengguna tertentu.	30	10
	ListRecentViewReports	Menanyakan daftar karya yang baru-baru ini atau sering dilihat pada halaman Dasbor Saya untuk pengguna tertentu.	30	10
Studio Layanan Data	QueryDataService	Memanggil operasi API yang dibuat di Studio Layanan Data.	10	60
Analitik tertanam	CreateTicket	Menghasilkan tiket untuk penyematan pihak ketiga.	50	10
	QueryTicketInfo	Menanyakan detail tiket yang digunakan untuk menyematkan laporan.	30	10
	DeleteTicket	Menghapus tiket yang digunakan untuk menyematkan laporan.	50	10
	DelayTicketExpireTime	Memperbarui waktu kedaluwarsa tiket yang digunakan untuk menyematkan laporan.	50	10
	UpdateTicketNum	Memperbarui jumlah tiket yang dapat digunakan untuk menyematkan laporan.	50	10
Persetujuan terbuka	ResultCallback	Operasi API callback untuk alur kerja persetujuan kustom. Anda dapat menggunakan operasi ini untuk memproses alur kerja persetujuan di Quick BI.	30	10

Lihat versi SDK

Dalam file pom.xml, pastikan bahwa nilai version adalah versi terbaru yang tersedia di alamat unduhan SDK.

Anda dapat melihat versi SDK di https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public.

Cara mencegah jumlah permintaan konkuren per detik melebihi ambang batas pengendalian aliran

Deskripsi masalah: Untuk tujuan kinerja dan keamanan, operasi API Quick BI yang diterapkan di cloud publik dikendalikan alirannya secara default. Jika Anda menggunakan thread konkuren untuk memanggil operasi API dan jumlah permintaan per detik (QPS) aktual melebihi ambang batas pengendalian aliran, permintaan akan gagal.

Solusi: Anda dapat menggunakan kelas RateLimiter dari komponen Google Guava untuk membatasi QPS permintaan API.

Jika Anda menggunakan Maven untuk mengelola proyek Java Anda, tambahkan dependensi Maven ke file pom.xml.
```
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>${google.guava.version}</version>
</dependency>
```
Catatan
Dalam file pom.xml, pastikan bahwa nilai version adalah versi terbaru yang tersedia di alamat unduhan. Untuk versi terbaru, lihat Guava: Google Core Libraries For Java.

Buat dan gunakan RateLimiter.

Anda dapat menggunakan metode pabrik create() untuk membuat instance RateLimiter. Untuk informasi selengkapnya, lihat https://www.baeldung.com/guava-rate-limiter.

// Buat RateLimiter untuk pengendalian aliran dengan batas 30 QPS.
RateLimiter rateLimiter = RateLimiter.create(30);
// Mendapatkan izin. Jika QPS melebihi 30, permintaan akan diblokir dan harus menunggu.
rateLimiter.acquire();
// Permintaan API hanya dapat dikirim setelah izin diperoleh.
doSomeAPIRequest();

Catatan

Permintaan per detik (QPS) adalah jumlah permintaan atau tugas yang diproses per detik.

Konkurensi adalah jumlah permintaan atau tugas yang diproses sistem secara bersamaan.

QPS = Konkurensi/Waktu tanggapan rata-rata.