Topik ini memberikan ikhtisar mengenai DataWorks OpenAPI, mencakup informasi dasar, batasan penggunaan, penagihan, dan cara memanggilnya.
Informasi dasar
|
Versi |
Portal OpenAPI |
API yang didukung |
Wilayah yang didukung |
|
2024-05-18 (Versi baru) |
Tiongkok (Hangzhou), Tiongkok (Shanghai), Tiongkok (Shenzhen), Tiongkok (Beijing), Tiongkok (Zhangjiakou), China North 2 Ali Gov, China East 2 Finance, Tiongkok (Chengdu), Tiongkok (Hong Kong), Singapura, Indonesia (Jakarta), AS (Silicon Valley), AS (Virginia), Jerman (Frankfurt), Inggris (London), Jepang (Tokyo), dan Malaysia (Kuala Lumpur) Penting
Catatan mengenai API terkait Data Studio:
Periksa apakah Anda menggunakan Data Studio versi baru dan pilih versi OpenAPI yang sesuai. Memilih versi yang salah dapat menyebabkan kegagalan kueri atau mengembalikan hasil yang tidak diharapkan. |
||
|
2020-05-18 (Versi lama) |
Batasan
-
Persyaratan edisi untuk OpenAPI suatu modul mengikuti persyaratan edisi modul tersebut.
-
Untuk mengatur pemanggilan DataWorks OpenAPI dan menjaga stabilitas sistem, API diklasifikasikan sebagai read atau write. Setiap edisi DataWorks memiliki batas QPS (queries per second) tertentu. Edisi Dasar juga memiliki batas pemanggilan harian, sedangkan Edisi Standar, Edisi Profesional, dan Edisi Perusahaan tidak. Setiap edisi menyediakan kuota gratis bulanan serta menerapkan skema bayar sesuai penggunaan (pay-as-you-go) untuk pemanggilan yang melebihi kuota tersebut. Tabel berikut merangkum rincian ini.
Edisi
Batas QPS
Batas pemanggilan harian
Kuota gratis bulanan
Harga bayar sesuai penggunaan
Edisi Dasar
Total QPS untuk semua API: ≤5
Total pemanggilan API per hari: ≤100
3.100 pemanggilan/bulan
Tunduk pada batas pemanggilan. Bayar sesuai penggunaan tidak didukung.
Edisi Standar
Pemanggilan API harian tanpa batas
100.000 pemanggilan/bulan
USD 0,05 per 10.000 pemanggilan
Edisi Profesional
Pemanggilan API harian tanpa batas
500.000 pemanggilan/bulan
USD 0,05 per 10.000 pemanggilan
Edisi Perusahaan
-
Total QPS untuk API read: ≤50
-
Total QPS untuk API write: ≤20
Pemanggilan API harian tanpa batas
1.000.000 pemanggilan/bulan
USD 0,05 per 10.000 pemanggilan
Penting-
QPS API dan jumlah pemanggilan dihitung secara kumulatif untuk satu Akun Alibaba Cloud beserta Pengguna RAM-nya di setiap wilayah.
-
Jika batas QPS terlampaui atau batas pemanggilan harian untuk Edisi Dasar tercapai, pemanggilan selanjutnya akan gagal. Kelola konkurensi dan frekuensi pemanggilan agar tidak melebihi batas tersebut.
-
Pada Edisi Dasar, baik pemanggilan API yang berhasil maupun yang gagal tetap dihitung dalam batas pemanggilan harian. Edisi Standar, Profesional, dan Perusahaan tidak memiliki batas pemanggilan harian; hanya pemanggilan yang berhasil yang dihitung terhadap kuota gratis bulanan. Pantau penggunaan kuota gratis dan aturan bayar sesuai penggunaan Anda.
-
Jenis API (read atau write) dapat ditentukan dari namanya. Misalnya,
CreateFileadalah API write, sedangkanListFilesadalah API read.
-
Prasyarat
Sebelum memanggil OpenAPI, pastikan Anda memiliki izin AliyunDataWorksFullAccess untuk menghindari kegagalan akibat izin yang tidak mencukupi. Untuk informasi lebih lanjut, lihat Izin pengguna.
Kuota gratis dan metode penagihan
Kuota gratis bulanan untuk setiap edisi, harga bayar sesuai penggunaan jika melebihi kuota, serta batasan seperti QPS dan jumlah pemanggilan harian dirangkum dalam tabel di bagian Batasan. Bagian ini memberikan rincian tambahan mengenai perhitungan penagihan dan catatan penting lainnya.
-
Setiap Akun Alibaba Cloud (termasuk Pengguna RAM-nya) menerima kuota gratis bulanan untuk pemanggilan OpenAPI di setiap wilayah. Kuota gratis bervariasi tergantung edisi DataWorks.
-
Edisi Dasar tunduk pada batas pemanggilan harian dan kuota gratis bulanan (lihat Batasan). Setelah melebihi batas tersebut, Anda tidak dapat melakukan pemanggilan lagi, dan opsi bayar sesuai penggunaan tidak tersedia. Edisi Standar dan Edisi Profesional tidak memiliki batas pemanggilan harian tetapi menyediakan kuota gratis bulanan (lihat tabel ringkasan di bagian Batasan). Setelah kuota gratis habis, pemanggilan selanjutnya dikenai biaya berdasarkan skema bayar sesuai penggunaan. Untuk rincian harga dan perbedaan antar lingkungan, lihat bagian penagihan OpenAPI dalam Biaya sumber daya. Edisi Perusahaan tidak memiliki batas pemanggilan harian, dan setelah kuota gratisnya habis, aturan penagihan bayar sesuai penggunaan yang sama tetap berlaku.
-
Untuk Edisi Standar, Profesional, dan Perusahaan DataWorks, Anda dapat terus melakukan pemanggilan dengan skema bayar sesuai penggunaan setelah kuota gratis bulanan habis. Situs internasional menggunakan harga satuan dan penagihan yang tercantum dalam dokumentasi. Untuk informasi lebih lanjut, lihat Biaya sumber daya. Harga pada tagihan akhir Anda yang berlaku.
Pemanggilan API
Untuk informasi lengkap mengenai cara memanggil Alibaba Cloud OpenAPI, lihat Ikhtisar.
Metode pemanggilan
|
Metode pemanggilan |
Didukung |
Deskripsi |
|
Alibaba Cloud SDK (Direkomendasikan) |
Ya |
Untuk informasi mengenai bahasa pemrograman yang didukung oleh SDK DataWorks dan cara menginstal dependensinya, lihat DataWorks SDK. |
|
Ya |
Jika Anda menggunakan pemanggilan HTTP native, Anda harus mengimplementasikan algoritma signature dan membuat permintaan kustom. Untuk informasi lebih lanjut mengenai mekanisme signature, lihat Struktur permintaan dan signature. |
Contoh pemanggilan
-
DataWorks SDK (Direkomendasikan)
Gaya API
DataWorks OpenAPI menggunakan gaya RPC.
Titik akhir
Pilih titik akhir untuk wilayah tempat ruang kerja DataWorks Anda berada guna meminimalkan latensi. Sebagai contoh, titik akhir VPC untuk wilayah Tiongkok (Zhangjiakou) adalah dataworks-vpc.cn-zhangjiakou.aliyuncs.com. Untuk informasi lebih lanjut, lihat Titik akhir (2024-05-18) dan Titik akhir (2020-05-18).
Penggunaan OpenAPI
Anda dapat menggunakan Open Platform untuk melihat penggunaan OpenAPI Anda, termasuk konsumsi kuota gratis, jumlah pemanggilan, dan detail penjadwalan. Untuk informasi lebih lanjut, lihat OpenAPI.