panggil dataworks openapi - DataWorks

Topik ini menjelaskan informasi dasar, batasan, penagihan, dan petunjuk pemanggilan untuk DataWorks OpenAPI.

Informasi Dasar

Versi	Portal OpenAPI	Daftar API yang didukung	Wilayah yang didukung
2024-05-18 (OpenAPI baru)	Portal OpenAPI	Daftar API yang didukung	Tiongkok (Hangzhou), Tiongkok (Shanghai), Tiongkok (Shenzhen), Tiongkok (Beijing), Tiongkok (Zhangjiakou), Alibaba Gov Cloud, Cloud Keuangan Tiongkok (Shanghai), 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 penggunaan untuk OpenAPI terkait Pengembangan Data: Jika Anda Use The New Data Studio, gunakan versi 2024-05-18. Jika Anda tidak Use The New Data Studio, gunakan versi 2020-05-18. Konfirmasi apakah Anda Use The New Data Studio dan pilih versi OpenAPI yang sesuai. Jika Anda memilih versi yang salah, kueri Anda mungkin gagal atau Anda tidak mendapatkan hasil yang diharapkan.
2020-05-18 (OpenAPI lama)	Portal OpenAPI	Daftar API yang didukung

Batasan

DataWorks menyediakan OpenAPI untuk berbagai modul fitur, seperti penyewa, metadata, Pengembangan Data, dan Pusat Operasi. Persyaratan edisi untuk suatu OpenAPI sama dengan persyaratan edisi untuk fitur yang sesuai.

Untuk menstandarkan pemanggilan DataWorks OpenAPI dan memastikan stabilitas sistem, OpenAPI diklasifikasikan menjadi tipe baca dan tulis. Edisi DataWorks yang berbeda memiliki batas permintaan per detik (QPS) dan batas panggilan harian yang berbeda untuk OpenAPI baca dan tulis. Rinciannya sebagai berikut.

Edisi	Batas QPS	Panggilan harian maksimum
Edisi Dasar	Total QPS untuk semua OpenAPI ≤ 5	Jumlah total panggilan API per hari tidak boleh melebihi 100.
Edisi Standar		Jumlah total panggilan API per hari tidak boleh melebihi 1.000.
Edisi Profesional		Jumlah total panggilan API harian tidak boleh melebihi 10.000.
Edisi Perusahaan	Total QPS untuk OpenAPI baca ≤ 50 Total QPS untuk OpenAPI tulis ≤ 20	Tidak ada batas jumlah panggilan API harian.

Penting

Batas QPS dan panggilan berlaku untuk jumlah total panggilan yang dilakukan oleh Akun Alibaba Cloud dan Pengguna RAM-nya di setiap Wilayah.
Jika batas QPS atau panggilan harian terlampaui, panggilan akan gagal. Anda harus mengontrol konkurensi dan jumlah panggilan secara sesuai.
Panggilan yang berhasil maupun gagal sama-sama diperhitungkan terhadap batas panggilan harian.
Anda dapat menentukan tipe baca atau tulis suatu OpenAPI dari namanya. Misalnya, CreateFile adalah OpenAPI tulis dan ListFiles adalah OpenAPI baca.

Prasyarat

Sebelum memanggil OpenAPI, pastikan izin AliyunDataWorksFullAccess telah diberikan untuk mencegah kegagalan panggilan akibat izin yang tidak mencukupi. Untuk informasi selengkapnya, lihat Kontrol akses.

Kuota gratis dan metode penagihan

Setiap versi OpenAPI mencakup kuota panggilan gratis bulanan. Setelah kuota gratis habis, panggilan dikenai biaya berdasarkan metode bayar sesuai penggunaan. Tabel berikut menjelaskan kuota gratis dan harga bayar sesuai penggunaan.

Edisi	Kuota panggilan gratis	Harga bayar sesuai penggunaan setelah kuota gratis habis
Edisi Dasar	3.100 panggilan/bulan	Batas panggilan berlaku. Penagihan bayar sesuai penggunaan tidak didukung.
Edisi Standar	31.000 panggilan/bulan
Edisi Profesional	310.000 panggilan/bulan
Edisi Perusahaan	1.000.000 panggilan/bulan	USD 0.05 per 10.000 panggilan

Penting

Di setiap Wilayah, setiap Akun Alibaba Cloud menerima kuota panggilan OpenAPI gratis setiap bulan kalender. Kuota ini dibagi antara akun dan Pengguna RAM-nya. Kuota gratis bervariasi berdasarkan edisi DataWorks.
Karena adanya batas panggilan harian pada edisi DataWorks yang berbeda, jumlah panggilan bulanan aktual untuk Edisi Dasar, Standar, dan Profesional tidak akan melebihi kuota gratis. Oleh karena itu, penagihan bayar sesuai penggunaan tidak didukung untuk edisi-edisi tersebut. Untuk informasi selengkapnya, lihat Batasan.
Setelah kuota gratis untuk DataWorks Edisi Perusahaan habis, panggilan dikenai biaya berdasarkan metode bayar sesuai penggunaan. Harga aktual pada tagihan Anda yang berlaku.
Hanya panggilan OpenAPI yang berhasil yang mengurangi kuota gratis dan dikenai biaya bayar sesuai penggunaan setelah kuota habis. Panggilan OpenAPI yang gagal tidak mengurangi kuota gratis dan tidak dikenai biaya.

Petunjuk pemanggilan

Catatan

Untuk informasi selengkapnya tentang penggunaan Alibaba Cloud OpenAPI, lihat Alibaba Cloud OpenAPI.

Metode pemanggilan

Metode Pemanggilan	Didukung	Deskripsi
SDK Alibaba Cloud (Direkomendasikan)	Dukungan	Untuk informasi tentang bahasa yang didukung dan metode instalasi dependensi untuk kit pengembangan perangkat lunak (SDK) DataWorks, lihat DataWorks SDK.
Panggilan HTTP native	Dukungan	Dengan panggilan HTTP native, Anda harus mengimplementasikan algoritma tanda tangan, membuat permintaan kustom, dan memulai panggilan HTTP. Untuk informasi selengkapnya tentang mekanisme tanda tangan, lihat Struktur permintaan dan mekanisme tanda tangan.

Contoh pemanggilan

DataWorks SDK (Direkomendasikan)
Panggil OpenAPI melalui HTTP

Gaya API

Gaya RPC.

Titik akhir

Pilih titik akhir berdasarkan Wilayah tempat Proyek DataWorks Anda berada untuk mencapai latensi terendah. Misalnya, titik akhir VPC untuk wilayah 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 dengan mudah mengambil informasi penggunaan OpenAPI, termasuk penggunaan kuota gratis, jumlah panggilan, dan detail penjadwalan. Untuk informasi selengkapnya, lihat Open API (OpenAPI).