Topik ini menjelaskan dasar-dasar penggunaan ApsaraDB for HBase OpenAPI.
Ikhtisar OpenAPI
Alibaba Cloud menyediakan Portal OpenAPI untuk membantu Anda menggunakan OpenAPI secara efisien. Portal ini merupakan produk komprehensif yang mengintegrasikan fitur-fitur seperti pencarian API cerdas, dokumentasi, debugging online, pengambilan SDK, contoh kode, diagnosis kesalahan pemanggilan, dan statistik pemanggilan. Di Portal OpenAPI, Anda dapat memanggil operasi OpenAPI dari berbagai Produk Alibaba Cloud serta melihat permintaan dan responsnya. Portal OpenAPI juga secara otomatis menghasilkan contoh kode SDK untuk membantu Anda memulai dengan cepat. Untuk informasi selengkapnya, lihat Apa itu OpenAPI.
Versi
Alibaba Cloud OpenAPI menggunakan nomor versi untuk mengelola API untuk kluster ApsaraDB for Hbase dengan arsitektur berbeda. Berikut adalah versi API yang didukung oleh ApsaraDB for HBase.
|
Versi |
Deskripsi |
|
2019-01-01 |
Gunakan versi ini untuk memanggil operasi API untuk semua kluster ApsaraDB for Hbase. |
Debugging Online
ApsaraDB for Hbase menyediakan fitur debugging API di Portal OpenAPI. Sebelum melakukan pemanggilan, Anda perlu memahami informasi seperti versi, deskripsi endpoint, dan metode integrasi yang disediakan oleh ApsaraDB for Hbase.
Di halaman Portal OpenAPI, panel kiri berisi pohon navigasi API dengan kategori seperti wilayah layanan, kluster, instans, keamanan, dan backup. Panel debugging berada di tengah, tempat Anda dapat memilih alamat layanan, mengonfigurasi parameter permintaan seperti AcceptLanguage dan Engine, lalu mengklik Initiate Call. Panel kanan menampilkan dokumentasi, termasuk deskripsi parameter permintaan dan respons, serta contoh SDK dan CLI.
Portal debugging
Untuk portal debugging API ApsaraDB for Hbase, lihat API Debugging Portal.
Endpoint
Untuk meminimalkan latensi, pilih endpoint di wilayah yang sama dengan sumber daya Anda. Misalnya, endpoint VPC di wilayah Tiongkok (Qingdao) adalah hbase.aliyuncs.com.
-
Endpoint publik dapat diakses secara global.
-
Virtual Private Cloud (VPC) adalah jaringan virtual terisolasi. Keuntungan menggunakan endpoint VPC meliputi:
-
Keamanan lebih tinggi: Endpoint VPC hanya dapat diakses dalam VPC, sehingga memberikan keamanan yang lebih baik.
-
Waktu respons lebih cepat: Endpoint VPC beroperasi dalam jaringan internal VPC, yang biasanya menghasilkan respons lebih cepat dan menghindari latensi jaringan publik.
-
Biaya lebih rendah: Endpoint VPC menggunakan komunikasi jaringan internal.
-
Untuk informasi selengkapnya, lihat struktur permintaan.
Identitas pengguna
Saat Anda masuk ke Portal OpenAPI, portal tersebut secara default menggunakan akun Anda saat ini untuk debugging online. Karena Akun Alibaba Cloud memiliki izin untuk mengakses semua API, menggunakannya untuk debugging menimbulkan risiko keamanan yang tinggi. Kami tidak menyarankan Anda menggunakan Akun Alibaba Cloud untuk debugging online. Sebaiknya buat dan gunakan RAM user untuk akses API dan operasi & pemeliharaan (O&M) sehari-hari. Sebelum memanggil operasi API, berikan RAM user hanya izin yang diperlukan. RAM user harus memiliki izin untuk mengelola ApsaraDB for Hbase. Untuk informasi selengkapnya, lihat Buat kebijakan otorisasi RAM kustom.
|
Identitas pengguna |
Didukung |
|
Didukung |
|
|
RAM user (Direkomendasikan) |
Didukung |
|
RAM role (Direkomendasikan) |
Didukung |
Metode integrasi
ApsaraDB for Hbase menyediakan berbagai metode integrasi, termasuk SDK Alibaba Cloud dan enkapsulasi kustom. Anda dapat memilih metode yang paling sesuai dengan kebutuhan bisnis Anda.
SDK mudah diintegrasikan dan merupakan cara yang direkomendasikan untuk memanggil operasi OpenAPI.
|
Metode integrasi |
Didukung |
|
Alibaba Cloud SDK |
Didukung |
|
Alibaba Cloud CLI |
Didukung |
|
Terraform |
Didukung |
|
Resource Orchestration Service (ROS) |
Didukung |
|
Custom encapsulation |
Didukung |
Alibaba Cloud SDK
-
Alibaba Cloud menyediakan SDK dalam berbagai bahasa pemrograman, seperti Java, C#, Go, Python, PHP, dan C++. SDK menangani detail dasar pemanggilan API, seperti identitas, autentikasi, dan aturan signature. Anda hanya perlu mengintegrasikan SDK untuk langsung memanggil operasi OpenAPI. Untuk informasi selengkapnya tentang Alibaba Cloud SDK, lihat Alibaba Cloud SDK.
-
Anda dapat menggunakan Alibaba Cloud SDK untuk memanggil operasi OpenAPI ApsaraDB for Hbase. Untuk daftar bahasa yang didukung dan instruksi instalasi, lihat Install SDKs.
Alibaba Cloud CLI
-
Alibaba Cloud CLI adalah tool command-line yang memungkinkan Anda mengelola layanan dan sumber daya Alibaba Cloud dengan perintah
aliyun. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI. -
Anda dapat menggunakan Alibaba Cloud CLI untuk memanggil operasi OpenAPI ApsaraDB for Hbase. Untuk informasi selengkapnya, lihat Call an RPC API.
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) adalah layanan Alibaba Cloud yang menyederhanakan pengelolaan sumber daya cloud. Anda dapat menulis templat untuk mendefinisikan sumber daya Alibaba Cloud yang Anda perlukan, seperti instance ECS dan instance database RDS, beserta dependensinya. Mesin ROS kemudian secara otomatis membuat dan mengonfigurasi semua sumber daya berdasarkan templat tersebut, sehingga memungkinkan penerapan dan O&M otomatis. Untuk informasi selengkapnya, lihat Apa itu Resource Orchestration Service.
-
Anda dapat menggunakan ROS untuk mengatur dan memanggil sumber daya ApsaraDB for Hbase. Untuk daftar sumber daya dan sumber data yang didukung, lihat Resources supported by ROS.
Custom encapsulation
Anda dapat membuat permintaan enkapsulasi kustom untuk mengakses Alibaba Cloud OpenAPI dengan mengikuti dokumentasi signature V3 untuk SDK. Untuk pemanggilan HTTP native, Anda harus mengimplementasikan algoritma signing, menyusun permintaan, lalu mengirimkannya. Untuk detail mekanisme signature, lihat V3 request body and signature mechanism.
Catatan
Jika pemanggilan API mengembalikan kesalahan, rujuk kode kesalahan yang dikembalikan untuk memeriksa parameter dan nilai permintaan Anda. Untuk informasi selengkapnya, lihat Error Code Center.
Anda juga dapat mencatat RequestID atau pesan kesalahan SDK dari respons dan menggunakan Alibaba Cloud OpenAPI Diagnostic Platform untuk diagnostik self-service.