Gunakan SDK ApsaraDB for ClickHouse dalam berbagai bahasa pemrograman - ApsaraDB for ClickHouse

Tema ini menjelaskan informasi dasar dan catatan penggunaan untuk memanggil ApsaraDB for ClickHouse Operasi API.

Ikhtisar OpenAPI Explorer

Alibaba Cloud menyediakan OpenAPI Explorer untuk membantu Anda memahami dan menggunakan operasi API dari berbagai layanan Alibaba Cloud secara efisien. OpenAPI Explorer mengintegrasikan fitur-fitur seperti pencarian cerdas, dokumentasi, debugging online, pengambilan SDK, kode contoh, diagnosis kesalahan panggilan, dan statistik panggilan. Di OpenAPI Explorer, Anda dapat memanggil operasi API layanan Alibaba Cloud serta melihat permintaan dan respons API. Selain itu, OpenAPI Explorer secara otomatis menghasilkan kode contoh SDK yang sesuai untuk mempermudah penggunaan layanan Alibaba Cloud. Untuk informasi lebih lanjut, lihat Apa itu API?.

Deskripsi Versi

API Alibaba Cloud menggunakan nomor versi untuk mengelola operasi API kluster ApsaraDB for ClickHouse dengan arsitektur yang berbeda. Anda dapat memilih API yang sesuai berdasarkan edisi kluster Anda.

Nomor Versi	Deskripsi
2019-11-11	Operasi API versi ini cocok untuk kluster Edisi Kompatibel Komunitas.
2023-05-22	Operasi API versi ini cocok untuk kluster Edisi Perusahaan.

Debugging Online

ApsaraDB for ClickHouse menyediakan fitur debugging API di OpenAPI Explorer. Sebelum memanggil operasi API, Anda harus memahami informasi berikut yang disediakan oleh ApsaraDB for ClickHouse: versi, titik akhir, dan metode integrasi.

URL Debugging API

URL debugging API dari ApsaraDB for ClickHouse Edisi Kompatibel Komunitas dan Edisi Perusahaan berbeda. Anda perlu memilih URL yang tepat berdasarkan edisi kluster Anda.

Edisi	Deskripsi
Edisi Kompatibel Komunitas	URL debugging API untuk ApsaraDB for ClickHouse Edisi Kompatibel Komunitas
Edisi Perusahaan	URL debugging API untuk ApsaraDB for ClickHouse Edisi Perusahaan

Deskripsi Titik Akhir

Anda dapat memilih titik akhir berdasarkan wilayah tempat sumber daya Anda berada untuk mengurangi latensi. Jika ApsaraDB for ClickHouse berada di wilayah Tiongkok (Zhangjiakou), titik akhir publiknya adalah clickhouse.cn-zhangjiakou.aliyuncs.com, dan titik akhir virtual private cloud (VPC) adalah clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.

Titik akhir publik dapat diakses secara global.
VPC terisolasi satu sama lain. Setiap VPC sesuai dengan jaringan virtual. Titik akhir VPC memiliki manfaat berikut:
- Keamanan lebih tinggi: Titik akhir VPC hanya dapat diakses dalam VPC yang sesuai, memberikan keamanan dan privasi yang lebih baik.
- Respon lebih cepat: Titik akhir VPC menggunakan lingkungan jaringan internal, sehingga memberikan respon lebih cepat daripada titik akhir publik. Selain itu, Anda tidak akan menghadapi masalah seperti latensi jaringan dan batasan bandwidth.
- Biaya lebih rendah: Titik akhir VPC diakses melalui jaringan internal.

Untuk informasi lebih lanjut, lihat Titik Akhir.

Identitas Pengguna yang Didukung

Setelah masuk ke OpenAPI Explorer menggunakan akun Alibaba Cloud Anda, OpenAPI Explorer secara default menggunakan akun tersebut untuk melakukan debugging online. Akun Alibaba Cloud memiliki izin pada semua operasi API. Namun, risiko keamanan mungkin muncul jika Anda menggunakan akun utama untuk debugging API secara online. Kami menyarankan Anda menggunakan pengguna RAM untuk memanggil operasi API atau melakukan O&M rutin. Sebelum memanggil operasi API sebagai pengguna RAM, pastikan pengguna RAM memiliki izin yang diperlukan berdasarkan kebutuhan bisnis Anda. Pastikan bahwa pengguna RAM memiliki izin manajemen pada ApsaraDB for ClickHouse. Untuk informasi lebih lanjut, lihat Otorisasi RAM.

Identitas	Didukung
Akun Alibaba Cloud	Ya
Pengguna RAM (direkomendasikan)	Ya
Peran RAM (direkomendasikan)	Ya

Metode Integrasi

ApsaraDB for ClickHouse menyediakan metode integrasi berikut: Alibaba Cloud SDK, Terraform, Resource Orchestration Service (ROS), dan enkapsulasi kustom. Anda dapat memilih metode integrasi berdasarkan kebutuhan bisnis Anda.

Catatan

SDK merupakan metode yang paling direkomendasikan untuk memanggil operasi API karena mudah diintegrasikan.

Metode Integrasi	Didukung
Alibaba Cloud SDK	Ya
Alibaba Cloud CLI	Tidak
Terraform	Tidak
ROS	Sebagian didukung
Enkapsulasi Kustom	Ya

Alibaba Cloud SDK

Alibaba Cloud menyediakan SDK dalam berbagai bahasa pemrograman, seperti Java, C#, Go, Python, Node.js, TypeScript, PHP, dan C++. SDK membebaskan Anda dari mempertimbangkan detail implementasi operasi API, serta menstandarisasi identitas, autentikasi, dan aturan penandatanganan. Anda hanya perlu mengintegrasikan SDK dan menggunakannya untuk langsung memanggil operasi API. Untuk informasi lebih lanjut tentang Alibaba Cloud SDK, lihat Alibaba Cloud SDK.
Alibaba Cloud SDK dapat digunakan untuk memanggil operasi API ApsaraDB for ClickHouse. Untuk informasi lebih lanjut tentang bahasa pemrograman yang didukung dan instalasi dependensi, lihat Ikhtisar SDK.

Alibaba Cloud CLI

Alibaba Cloud CLI memungkinkan Anda menggunakan perintah aliyun di shell CLI untuk berinteraksi dengan layanan Alibaba Cloud dan mengelola sumber daya layanan cloud. Untuk informasi lebih lanjut tentang Alibaba Cloud CLI, lihat Apa itu Alibaba Cloud CLI?.
Alibaba Cloud CLI tidak dapat digunakan untuk memanggil operasi API dari ApsaraDB for ClickHouse.

Terraform

Terraform adalah alat open source yang aman dan efisien untuk mempratinjau, mengonfigurasi, dan mengelola infrastruktur cloud dan sumber daya. Terraform bekerja dengan cara yang mirip dengan ROS. Terraform memanggil API dengan menafsirkan templat. Untuk informasi lebih lanjut, lihat Apa itu Terraform?.
Terraform tidak dapat digunakan untuk memanggil operasi API ApsaraDB for ClickHouse.

ROS

ROS adalah layanan Alibaba Cloud yang dapat menyederhanakan pengelolaan sumber daya komputasi cloud. Anda dapat membuat templat untuk mendefinisikan sumber daya Alibaba Cloud yang diperlukan seperti Elastic Compute Service (ECS) dan instance ApsaraDB RDS, serta hubungan ketergantungan antara sumber daya tersebut. Mesin ROS secara otomatis membuat dan mengonfigurasi semua sumber daya dalam tumpukan berdasarkan templat untuk menerapkan penyebaran dan O&M otomatis. Untuk informasi lebih lanjut, lihat Apa itu ROS?.
ROS dapat digunakan untuk memanggil operasi API ApsaraDB for ClickHouse. Untuk informasi lebih lanjut tentang sumber daya dan sumber data yang didukung oleh ROS, lihat Sumber daya yang didukung oleh ROS.

Enkapsulasi Kustom

Anda dapat mengenkapsulasi permintaan API berdasarkan kebutuhan bisnis Anda untuk memanggil operasi API. Untuk membuat panggilan HTTP asli, Anda harus membuat permintaan kustom dan menandatangani permintaan tersebut. Untuk informasi lebih lanjut tentang mekanisme penandatanganan, lihat Sintaks Permintaan dan Metode Penandatanganan V3.

Catatan Penggunaan

Jika terjadi kesalahan setelah Anda memanggil operasi API, periksa apakah parameter permintaan dan nilai parameternya valid berdasarkan kode kesalahan yang dikembalikan. Untuk informasi lebih lanjut, lihat ApsaraDB for ClickHouse - Kode Kesalahan.

Anda juga dapat melakukan diagnosis mandiri berdasarkan ID permintaan yang dikembalikan atau informasi kesalahan SDK di halaman Diagnosis Masalah OpenAPI.