Topik ini menjelaskan informasi dasar dan catatan penting untuk menggunakan OpenAPI Lindorm.
OpenAPI
Alibaba Cloud menyediakan portal OpenAPI untuk membantu Anda mempelajari dan menggunakan API produk cloud secara cepat. Portal ini merupakan solusi terpadu yang mencakup fitur seperti pencarian API cerdas, dokumentasi, debugging online, akses SDK, contoh kode, diagnostik kesalahan, dan statistik pemanggilan. Anda dapat menggunakan portal ini untuk memanggil API berbagai produk Alibaba Cloud, melihat permintaan dan respons, serta menghasilkan contoh kode SDK secara otomatis guna mempercepat proses pengembangan. Untuk informasi selengkapnya, lihat Apa itu OpenAPI?.
Versi
Alibaba Cloud OpenAPI menggunakan nomor versi untuk mengelola API untuk kluster Lindorm dengan arsitektur berbeda. Berikut adalah versi API yang didukung oleh Lindorm beserta deskripsinya.
Versi | Deskripsi |
2020-06-15 | Semua instans Lindorm menggunakan nomor versi ini untuk memanggil API. |
Debugging Online
Lindorm menyediakan fitur debugging API di Portal OpenAPI. Sebelum memanggil API, Anda harus memahami versi, deskripsi titik akhir, dan metode integrasi Lindorm. Masuk ke OpenAPI Portal. Di bilah navigasi kiri, pilih versi API 2020-06-15. Di bawah kategori wilayah, pilih API DescribeRegions untuk mendapatkan semua wilayah yang didukung Lindorm. Dari daftar drop-down Service Address, pilih wilayah target seperti China (Hangzhou). Di bagian konfigurasi parameter, Anda dapat mengatur parameter AcceptLanguage (string, nilai contoh: zh-CN). Parameter respons mencakup RequestId (string) dan Regions (daftar wilayah). Setelah menyelesaikan pengaturan, klik Initiate Call.
Portal debugging
API Explorer untuk Lindorm tersedia di API Explorer.
Titik akhir
Pilih titik akhir di wilayah tempat sumber daya Anda berada untuk mengurangi latensi. Misalnya, titik akhir VPC untuk wilayah China (Qingdao) adalah hitsdb-vpc.cn-qingdao.aliyuncs.com.
-
Titik akhir publik dapat diakses secara global.
-
Virtual Private Cloud (VPC) adalah jaringan virtual terisolasi. Titik akhir VPC menawarkan manfaat berikut:
-
Keamanan tinggi: Karena titik akhir VPC hanya dapat diakses dari dalam VPC, mereka menyediakan keamanan dan privasi yang lebih baik.
-
Respons lebih cepat: Dengan menggunakan jaringan internal, titik akhir VPC memberikan waktu respons lebih cepat dibandingkan titik akhir publik dan tidak terpengaruh oleh latensi atau batas bandwidth jaringan publik.
-
Biaya lebih rendah: Menggunakan titik akhir VPC dapat mengurangi biaya transfer data karena komunikasi terjadi melalui jaringan internal.
-
-
Respons lebih cepat: Titik akhir VPC menggunakan jaringan internal sehingga memberikan waktu respons lebih cepat dibandingkan titik akhir publik, serta tidak terpengaruh oleh latensi jaringan publik maupun batas bandwidth.
-
Biaya lebih rendah: Penggunaan VPC endpoint dapat mengurangi biaya transfer data karena komunikasi berlangsung melalui jaringan internal.
Untuk informasi selengkapnya, lihat Titik Akhir.
Identitas pengguna yang didukung
Saat Anda masuk ke situs web OpenAPI, OpenAPI secara default menggunakan akun yang sedang Anda gunakan untuk debugging API online. Akun Alibaba Cloud memiliki izin untuk mengakses semua API, yang menimbulkan risiko keamanan tinggi. Oleh karena itu, kami tidak menyarankan Anda menggunakan akun Alibaba Cloud untuk debugging API online. Kami sangat menyarankan Anda membuat dan menggunakan RAM user untuk akses API atau operasi harian. Berikan izin kepada RAM user sesuai kebutuhan bisnis sebelum melakukan panggilan API. RAM user tersebut harus memiliki izin untuk mengoperasikan Lindorm. Untuk informasi selengkapnya, lihat Informasi Otorisasi.
Identitas pengguna | Didukung |
Ya | |
RAM user (disarankan) | Ya |
RAM role (disarankan) | Ya |
Metode integrasi
Lindorm menyediakan berbagai metode integrasi, seperti Alibaba Cloud SDK dan wrapper kustom. Anda dapat memilih metode yang paling sesuai dengan kebutuhan bisnis Anda.
SDK menyederhanakan integrasi dan merupakan cara yang direkomendasikan untuk memanggil operasi OpenAPI.
Metode integrasi | Didukung |
Alibaba Cloud SDK | Ya |
Alibaba Cloud CLI | Ya |
Terraform | Ya |
Resource Orchestration Service (ROS) | Ya |
Enkapsulasi kustom | Ya |
Alibaba Cloud SDK
-
Alibaba Cloud menyediakan SDK untuk berbagai bahasa pemrograman, termasuk Java, C#, Go, Python, PHP, dan C++. SDK mengabstraksi detail implementasi OpenAPI serta menstandarkan aturan identitas, otentikasi, dan penandatanganan. 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 OpenAPI Lindorm. Untuk daftar bahasa yang didukung dan metode instalasi dependensi, lihat Instalasi SDK.
Alibaba Cloud CLI
-
Alibaba Cloud CLI adalah alat command-line yang memungkinkan Anda berinteraksi dengan layanan Alibaba Cloud dan mengelola sumber daya cloud menggunakan perintah
aliyundi shell command-line. Untuk informasi selengkapnya tentang Alibaba Cloud CLI, lihat Apa itu Alibaba Cloud CLI?. -
Anda dapat menggunakan Alibaba Cloud CLI untuk memanggil OpenAPI Lindorm. Untuk informasi selengkapnya, lihat Panggil API RPC.
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) adalah layanan Alibaba Cloud yang menyederhanakan pengelolaan sumber daya cloud. Anda dapat membuat templat untuk mendefinisikan sumber daya Alibaba Cloud yang diperlukan, seperti instance ECS dan instance basis data RDS, beserta dependensinya. Mesin orkestrasi 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 ROS?.
-
Anda dapat menggunakan Resource Orchestration Service (ROS) untuk mengelola Lindorm. Untuk daftar resource standar dan data yang didukung, lihat Daftar Orkestrasi Resource.
Enkapsulasi kustom
Sebagai alternatif, Anda dapat membuat wrapper permintaan sendiri untuk mengakses Alibaba Cloud OpenAPI. Metode ini mengharuskan Anda mengimplementasikan algoritma penandatanganan V3, menyusun permintaan kustom, dan mengirimkannya melalui HTTP. Untuk informasi selengkapnya tentang mekanisme penandatanganan, lihat Badan Permintaan V3 & Mekanisme Penandatanganan.
Catatan penggunaan
Jika pemanggilan API mengembalikan kesalahan, periksa kode kesalahan yang dikembalikan dan tinjau parameter permintaan serta nilainya. Untuk informasi selengkapnya, lihat Pusat Kode Kesalahan.
Anda juga dapat mencatat RequestID yang dikembalikan atau pesan kesalahan SDK dan menggunakan Platform Diagnostik Alibaba Cloud OpenAPI untuk mendiagnosis masalah tersebut.