Katalog Layanan menyediakan konsol untuk operasi visual dan berbagai metode pemanggilan API, termasuk OpenAPI Explorer, Alibaba Cloud SDK. Untuk meningkatkan efisiensi pengembangan menggunakan Katalog Layanan, disarankan menggunakan operasi API dan metode integrasi yang sesuai dengan kebutuhan bisnis Anda.
Ikhtisar OpenAPI Explorer
Alibaba Cloud menyediakan OpenAPI Explorer untuk membantu pengembang memahami dan menggunakan operasi API dari berbagai layanan Alibaba Cloud secara cepat dan efisien. OpenAPI Explorer mencakup fitur seperti pencarian cerdas, dokumentasi, debugging online, unduhan SDK, kode contoh, diagnosis kesalahan, 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 untuk mempermudah penggunaan layanan Alibaba Cloud. Untuk informasi lebih lanjut, lihat Apa itu API?.
Versi
OpenAPI Explorer menggunakan nomor versi untuk mengelola versi utama operasi API layanan cloud. Sebagai contoh, Katalog Layanan mendukung API versi 2021-09-01. Nomor 2021-09-01 adalah nomor versi API, bukan tanggal pembaruan terakhir API tersebut. Setiap versi memberikan data API terbaru.
Versi API | Deskripsi |
Versi yang direkomendasikan. |
Debugging Online
Anda dapat memanggil operasi API Katalog Layanan di OpenAPI Explorer. Sebelum memanggil operasi API, pastikan Anda memahami informasi terkait API, seperti versi API, titik akhir, dan metode integrasi.
Halaman Debugging Online
Anda dapat memanggil operasi API Katalog Layanan pada halaman debugging online.
Titik Akhir
Pilih titik akhir berdasarkan wilayah tempat sumber daya Anda berada untuk mengurangi latensi. Sebagai contoh, jika Katalog Layanan Anda berada di wilayah Tiongkok (Hangzhou), titik akhir publiknya adalah servicecatalog.cn-hangzhou.aliyuncs.com, sedangkan titik akhir Virtual Private Cloud (VPC) adalah servicecatalog-vpc.cn-hangzhou.aliyuncs.com.
Titik akhir publik dapat diakses secara global.
Titik akhir VPC hanya dapat diakses dalam VPC di wilayah tertentu di Alibaba Cloud. Titik akhir VPC menawarkan manfaat sebagai berikut:
Keamanan lebih tinggi: Titik akhir VPC hanya dapat diakses dalam VPC, memberikan privasi dan keamanan tambahan.
Tanggapan lebih cepat: Titik akhir VPC menggunakan jaringan internal untuk memberikan tanggapan lebih cepat dibandingkan titik akhir publik. Selain itu, penggunaan titik akhir VPC bebas dari 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
Setelah masuk ke OpenAPI Explorer menggunakan akun Alibaba Cloud Anda, sistem akan menggunakan akun tersebut secara default untuk debugging online. Akun Alibaba Cloud memiliki izin penuh atas semua operasi API. Namun, risiko keamanan mungkin timbul jika Anda menggunakan akun utama untuk debugging API. Kami menyarankan Anda memanggil operasi API atau melakukan O&M rutin sebagai Pengguna Resource Access Management (RAM). Sebelum memanggil operasi API sebagai Pengguna RAM, berikan izin yang diperlukan kepada Pengguna RAM sesuai kebutuhan bisnis Anda. Pengguna RAM harus memiliki izin untuk mengelola Katalog Layanan. Untuk informasi lebih lanjut, lihat Gunakan RAM untuk kontrol akses.
Identitas | Didukung |
Ya | |
Pengguna RAM (direkomendasikan) | Ya |
Peran RAM (direkomendasikan) | Ya |
Referensi
Metode Integrasi
SDK dapat dengan mudah diintegrasikan ke dalam aplikasi Anda dan mencakup rentang operasi paling luas. Kami menyarankan Anda menggunakan SDK untuk memanggil operasi API.
Ikhtisar Metode Integrasi
Metode Integrasi | Didukung |
Alibaba Cloud SDK (direkomendasikan) | Ya |
Tidak | |
Tidak | |
Ya |
Alibaba Cloud SDK
Alibaba Cloud menyediakan SDK dalam berbagai bahasa pemrograman, termasuk Java, C#, Go, Python, Node.js, TypeScript, PHP, dan C++. Anda dapat mengintegrasikan SDK ke dalam aplikasi Anda untuk langsung memanggil operasi API. SDK mengenkapsulasi logika tanda tangan, mekanisme timeout, mekanisme ulang, serta mengembalikan objek respons terstruktur berdasarkan spesifikasi, sehingga memudahkan pengembangan. Untuk informasi lebih lanjut, lihat Alibaba Cloud SDK.
Anda dapat menggunakan SDK Katalog Layanan untuk memanggil operasi API di OpenAPI Explorer. Untuk informasi lebih lanjut tentang bahasa pemrograman yang didukung dan cara menginstal dependensi, lihat Service Catalog SDKs.
Alibaba Cloud CLI
Alibaba Cloud CLI memungkinkan Anda menjalankan perintah
aliyununtuk berinteraksi dengan layanan Alibaba Cloud dan mengelola sumber daya layanan cloud. Untuk informasi lebih lanjut, lihat Apa itu Alibaba Cloud CLI?.Anda tidak dapat menggunakan Alibaba Cloud CLI untuk memanggil operasi API Katalog Layanan.
ROS
ROS adalah layanan Alibaba Cloud yang menyederhanakan pengelolaan sumber daya komputasi cloud. Anda dapat membuat template untuk menggambarkan sumber daya komputasi cloud yang Anda butuhkan, seperti instance Elastic Compute Service (ECS) dan ApsaraDB RDS, serta hubungan antara sumber daya tersebut. ROS secara otomatis membuat dan mengonfigurasi semua sumber daya berdasarkan template untuk menerapkan penyebaran dan O&M otomatis. Untuk informasi lebih lanjut, lihat Apa itu ROS?.
Anda tidak dapat menggunakan ROS untuk memanggil operasi API Katalog Layanan.
Enkapsulasi Kustom
Untuk membuat panggilan HTTP asli, Anda harus membuat permintaan kustom dan menandatangani permintaan tersebut. Untuk informasi lebih lanjut tentang metode tanda tangan, lihat Daftar operasi berdasarkan fungsi dan Sintaks permintaan dan metode tanda tangan V3.
Catatan Penggunaan
Jika terjadi kesalahan setelah memanggil operasi API, Anda dapat memeriksa validitas parameter permintaan dan nilai parameternya berdasarkan kode kesalahan.
Anda juga dapat melakukan diagnosis mandiri berdasarkan ID permintaan yang dikembalikan atau informasi kesalahan SDK pada halaman Diagnosis Masalah OpenAPI.
Referensi
Katalog Layanan adalah layanan Infrastructure as Code (IaC) yang dikembangkan oleh Alibaba Cloud. Katalog Layanan membantu perusahaan mengonfigurasi layanan yang memenuhi persyaratan tertentu dan mendefinisikan batasan peluncuran layanan. Dengan cara ini, perusahaan dapat memilih layanan berdasarkan kebutuhan bisnis mereka secara nyaman ketika mereka memindahkan beban kerja mereka ke cloud. Hal ini meningkatkan efisiensi pengiriman layanan TI. Untuk informasi lebih lanjut, lihat Apa itu Katalog Layanan?.
Untuk informasi lebih lanjut tentang bahasa pemrograman yang didukung oleh SDK Katalog Layanan, lihat Ikhtisar SDK.