Pelajari cara memanggil API ApsaraDB for ClickHouse menggunakan OpenAPI Explorer, Alibaba Cloud SDK, dan metode integrasi lainnya.
OpenAPI
OpenAPI Explorer adalah platform terpadu untuk pencarian API, dokumentasi, debugging online, contoh kode SDK, diagnostik error, dan statistik pemanggilan. Gunakan platform ini untuk memanggil dan menguji API berbagai layanan Alibaba Cloud. Apa itu OpenAPI?
Versi
Setiap edisi kluster ApsaraDB for ClickHouse menggunakan versi API yang berbeda. Pilih versi yang sesuai dengan edisi Anda.
|
Nomor versi |
Deskripsi |
|
2019-11-11 |
Gunakan versi ini untuk memanggil API kluster Edisi Community-compatible. |
|
2023-05-22 |
Gunakan versi ini untuk memanggil API kluster Enterprise Edition. |
Debugging online
Anda dapat melakukan debugging API ApsaraDB for ClickHouse di OpenAPI Explorer. Sebelum melakukan panggilan, tinjau versi API, titik akhir, dan metode integrasi untuk ApsaraDB for ClickHouse.
Panel kiri menampilkan kategori API seperti Region management, Cluster management, dan Compute group management. Pilih API untuk melihat deskripsinya, konfigurasikan parameter seperti ZoneId dan RegionId, lalu klik Initiate Call untuk mengujinya. Panel kanan menampilkan deskripsi parameter dan nilai contohnya.
URL debugging API
ApsaraDB for ClickHouse tersedia dalam Edisi Community-compatible dan Enterprise Edition. Setiap edisi memiliki URL debugging yang berbeda.
|
Edisi |
URL debugging API |
|
Community-compatible Edition |
URL debugging API untuk ApsaraDB for ClickHouse Community-compatible Edition |
|
Enterprise Edition |
URL debugging API untuk ApsaraDB for ClickHouse Enterprise Edition |
Titik akhir
Untuk meminimalkan latensi, pilih titik akhir yang berada di wilayah yang sama dengan sumber daya Anda. Misalnya, untuk kluster ApsaraDB for ClickHouse di wilayah China (Zhangjiakou), titik akhir publiknya adalah clickhouse.cn-zhangjiakou.aliyuncs.com dan titik akhir VPC-nya adalah clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.
-
Titik akhir publik dapat diakses secara global.
-
Titik akhir VPC berjalan pada jaringan virtual terisolasi dan menawarkan keuntungan berikut:
-
Keamanan lebih tinggi: hanya dapat diakses dari dalam VPC.
-
Latensi lebih rendah: menggunakan jaringan internal, tidak terpengaruh oleh fluktuasi jaringan publik.
-
Biaya lebih rendah: trafik internal mengurangi biaya transfer data.
-
Semua wilayah dan titik akhir yang didukung tercantum dalam Titik akhir layanan.
Identitas pengguna yang didukung
OpenAPI Explorer secara default menggunakan akun yang sedang Anda gunakan untuk debugging. Karena Akun Alibaba Cloud memiliki izin API penuh, gunakan RAM user dengan izin minimum yang diperlukan untuk akses API serta operasi dan pemeliharaan (O&M) sehari-hari. Berikan RAM user tersebut izin untuk mengelola ApsaraDB for ClickHouse. Otorisasi RAM.
|
Identitas |
Didukung |
|
Ya |
|
|
RAM user (Direkomendasikan) |
Ya |
|
RAM role (Direkomendasikan) |
Ya |
Metode integrasi
ApsaraDB for ClickHouse mendukung beberapa metode integrasi: Alibaba Cloud SDK, Terraform, Resource Orchestration Service (ROS), dan enkapsulasi kustom.
SDK menyederhanakan integrasi dan merupakan metode yang direkomendasikan untuk memanggil OpenAPI.
|
Metode integrasi |
Didukung |
|
Alibaba Cloud SDK |
Ya |
|
Alibaba Cloud CLI |
Tidak didukung |
|
Terraform |
Tidak didukung |
|
Resource Orchestration Service (ROS) |
Didukung sebagian |
|
Enkapsulasi kustom |
Ya |
Alibaba Cloud SDK
-
Alibaba Cloud SDK mendukung Java, C#, Go, Python, Node.js, TypeScript, PHP, dan C++. SDK menangani autentikasi dan penandatanganan, sehingga Anda dapat langsung memanggil API. Alibaba Cloud SDK.
-
Anda dapat menggunakan Alibaba Cloud SDK untuk memanggil API ApsaraDB for ClickHouse. Bahasa yang didukung dan langkah instalasinya terdapat dalam Ikhtisar SDK ApsaraDB for ClickHouse.
Alibaba Cloud CLI
-
Alibaba Cloud CLI memungkinkan Anda mengelola sumber daya cloud dari shell menggunakan perintah
aliyun. Apa itu Alibaba Cloud CLI?. -
Anda tidak dapat menggunakan Alibaba Cloud CLI untuk memanggil API ApsaraDB for ClickHouse.
Terraform
-
Terraform adalah tool open-source untuk penyediaan dan pengelolaan infrastruktur cloud melalui templat. Apa itu Alibaba Cloud Terraform?.
-
Anda tidak dapat menggunakan Terraform untuk mengatur API ApsaraDB for ClickHouse.
Resource Orchestration Service (ROS)
-
ROS mengotomatiskan penyediaan sumber daya cloud melalui templat. Definisikan resource seperti instance ECS dan instance RDS beserta dependensinya, lalu ROS akan membuat dan mengonfigurasinya secara otomatis. Apa itu Resource Orchestration Service?.
-
Anda dapat menggunakan ROS untuk memanggil API ApsaraDB for ClickHouse. Jenis resource dan sumber data yang didukung tercantum dalam Daftar resource ROS.
Enkapsulasi kustom
Untuk panggilan HTTP native, implementasikan algoritma penandatanganan V3 dan buat permintaan secara manual. Body permintaan dan mekanisme penandatanganan untuk V3.
Catatan penggunaan
Jika pemanggilan API mengembalikan error, verifikasi parameter permintaan Anda terhadap Pusat kode error.
Gunakan RequestID atau pesan error SDK dari respons untuk mendiagnosis masalah di Platform Diagnostik OpenAPI Alibaba Cloud.