Topik ini memberikan ikhtisar mengenai DataWorks OpenAPI, mencakup informasi dasar, batasan penggunaan, penagihan, serta 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 1, 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 panggilan harian, sedangkan Edisi Standar, Edisi Profesional, dan Edisi Perusahaan tidak. Setiap edisi menyediakan kuota gratis bulanan dan menerapkan model bayar sesuai penggunaan (pay-as-you-go) untuk panggilan yang melebihi kuota tersebut. Tabel berikut merangkum rincian ini.
Versi
Batas QPS
Batas panggilan harian
Kuota gratis panggilan bulanan
Bayar sesuai penggunaan setelah melebihi kuota gratis
Edisi Dasar
Total QPS semua API ≤ 5
Total panggilan API harian ≤ 100
3.100 panggilan/bulan
Batas panggilan berlaku. Penagihan tambahan berbasis pay-as-you-go tidak didukung.
Edisi Standar
Tidak ada batas panggilan harian
100.000 panggilan/bulan
USD 0,05 per 10.000 panggilan
Edisi Profesional
Tidak ada batas panggilan harian
500.000 panggilan/bulan
USD 0,05 per 10.000 panggilan
Edisi Perusahaan
-
Total QPS API read ≤ 50
-
Total QPS API write ≤ 20
Tidak ada batas panggilan harian
1.000.000 panggilan/bulan
USD 0,05 per 10.000 panggilan
Tugas penjadwalan dasar DataWorks tidak dieksekusi melalui operasi OpenAPI. Habisnya kuota panggilan OpenAPI tidak memengaruhi eksekusi normal tugas penjadwalan berkala atau tugas batch. Hanya tugas yang secara langsung memanggil operasi OpenAPI—seperti node Python atau node PyODPS—yang mungkin terpengaruh. Instans terjadwal di lingkungan produksi telah dihasilkan sebelumnya dan tidak dikenai kuota panggilan API.
Penting-
QPS API dan jumlah panggilan dihitung sebagai nilai kumulatif dari setiap Akun Alibaba Cloud (termasuk Pengguna RAM) di setiap Wilayah.
-
Jika batas QPS atau batas panggilan harian Edisi Dasar terlampaui, panggilan akan gagal. Atur konkurensi dan frekuensi panggilan Anda secara sesuai.
-
Untuk Edisi Dasar, baik panggilan API yang berhasil maupun gagal dihitung terhadap batas panggilan harian. Edisi Standar, Edisi Profesional, dan Edisi Perusahaan tidak memiliki batas panggilan harian, dan panggilan yang gagal tidak dihitung terhadap kuota tersebut. Perhatikan kuota gratis panggilan bulanan dan aturan penagihan pay-as-you-go.
-
Anda dapat menentukan jenis read/write setiap API berdasarkan namanya. Misalnya,
CreateFileadalah API write, sedangkanListFilesadalah API read.
-
Prasyarat
Sebelum memanggil OpenAPI, pastikan izin AliyunDataWorksFullAccess telah diaktifkan. Jika tidak, panggilan OpenAPI mungkin gagal karena izin tidak mencukupi. Untuk informasi selengkapnya, lihat Berikan izin AliyunDataWorksFullAccess.
Kuota gratis dan penagihan
Kuota gratis panggilan bulanan, harga satuan pay-as-you-go setelah melebihi kuota, batas QPS, serta batas panggilan harian untuk setiap edisi dirangkum dalam tabel pada bagian Batasan di atas. Informasi berikut memberikan rincian tambahan mengenai metrik penagihan dan pertimbangan terkait.
-
Setiap bulan kalender, kuota gratis panggilan OpenAPI diberikan kepada setiap Akun Alibaba Cloud (termasuk Pengguna RAM) di setiap Wilayah. Kuota gratis bulanan bervariasi tergantung edisi DataWorks.
-
Edisi Dasar memiliki batas panggilan harian dan kuota gratis panggilan bulanan (untuk detailnya, lihat Batasan di atas). Panggilan akan ditolak setelah batas terlampaui, dan penagihan pay-as-you-go tidak didukung. Edisi Standar dan Edisi Profesional tidak memiliki batas panggilan harian dan masing-masing menyediakan kuota gratis panggilan bulanan (lihat tabel pada bagian Batasan di atas). Penagihan pay-as-you-go berlaku setelah kuota gratis habis. Untuk harga satuan dan perbedaan berdasarkan lingkungan, lihat Penagihan OpenAPI dalam Biaya sumber daya. Edisi Perusahaan tidak memiliki batas panggilan harian, dan aturan penagihan pay-as-you-go yang sama berlaku setelah kuota gratis habis.
-
DataWorks Edisi Standar, Edisi Profesional, dan Edisi Perusahaan mendukung kelanjutan panggilan API dengan harga pay-as-you-go setelah kuota gratis bulanan habis. Situs internasional menggunakan harga satuan dan penagihan yang tercantum dalam dokumentasi. Untuk informasi selengkapnya, lihat Biaya sumber daya. Harga penagihan aktual mengacu pada harga yang tertera pada Tagihan akhir Anda.
Cara memanggil OpenAPI
Untuk informasi selengkapnya mengenai Alibaba Cloud OpenAPI, lihat Alibaba Cloud OpenAPI.
Metode pemanggilan
|
Metode pemanggilan |
Status dukungan |
Deskripsi |
|
SDK (direkomendasikan) |
Didukung |
Untuk bahasa yang didukung oleh SDK DataWorks dan metode instalasi dependensinya, lihat DataWorks SDK. |
|
Didukung |
Panggilan HTTP native mengharuskan Anda mengimplementasikan algoritma signature dan menyusun permintaan kustom untuk memulai panggilan HTTP. Untuk informasi selengkapnya mengenai mekanisme signature, lihat Mekanisme signature. |
Contoh pemanggilan
-
DataWorks SDK (direkomendasikan)
Gaya API
Gaya RPC.
Titik akhir
Pilih Titik akhir yang sesuai dengan Wilayah tempat ruang kerja DataWorks Anda berada untuk mencapai latensi terendah. Sebagai contoh, Titik akhir VPC untuk Tiongkok (Zhangjiakou) adalah dataworks-vpc.cn-zhangjiakou.aliyuncs.com. Untuk informasi selengkapnya, lihat Titik akhir (2024-05-18) dan Titik akhir (2020-05-18).
Lihat penggunaan OpenAPI
Anda dapat menggunakan Open Platform untuk melihat penggunaan OpenAPI Anda, termasuk konsumsi kuota gratis, jumlah panggilan, dan detail panggilan. Untuk informasi selengkapnya, lihat Lihat penggunaan OpenAPI.