Selain Konsol Manajemen, Service Catalog menyediakan berbagai metode integrasi, termasuk debugging online di OpenAPI Explorer, Alibaba Cloud SDK. Untuk meningkatkan efisiensi pengembangan, pilih operasi dan metode integrasi yang paling sesuai dengan kebutuhan Anda.
Ikhtisar OpenAPI Explorer
Alibaba Cloud menyediakan OpenAPI Explorer bagi pengembang untuk memahami dan menggunakan operasi API berbagai layanan Alibaba Cloud secara cepat dan efisien. OpenAPI Explorer menawarkan berbagai fitur terkait operasi API, seperti pencarian cerdas, dokumentasi, debugging online, unduhan SDK, contoh kode, diagnosis kesalahan, dan statistik pemanggilan. Di OpenAPI Explorer, Anda dapat memanggil operasi API layanan Alibaba Cloud serta melihat permintaan dan respons API. Selain itu, OpenAPI Explorer secara otomatis menghasilkan contoh kode SDK yang sesuai untuk mempermudah penggunaan layanan Alibaba Cloud. Untuk informasi selengkapnya, lihat Apa itu API?
Versions
OpenAPI Explorer menggunakan nomor versi untuk mengelola versi utama operasi API layanan cloud. Sebagai contoh, Service Catalog mendukung API versi 2021-09-01. 2021-09-01 adalah nomor versi API, bukan tanggal terakhir kali API diperbarui. Anda akan menerima data API terbaru dalam setiap versi tersebut.
API version | Description |
Versi yang direkomendasikan. |
Online debugging
Anda dapat memanggil operasi API Service Catalog di OpenAPI Explorer. Sebelum memanggil operasi API Service Catalog, pastikan Anda memahami informasi terkait API tersebut, termasuk versi API, titik akhir (endpoints), dan metode integrasi.
Di OpenAPI Explorer, pilih operasi GetProductAsEndUser untuk debugging. Untuk Service Address, pilih wilayah target, misalnya China (Hangzhou). Di area konfigurasi parameter, masukkan parameter yang diperlukan ProductId (Product ID, string, contohnya prod-bp18r7q127****), lalu klik Initiate Call. Sebelum melakukan pemanggilan, pastikan administrator telah memberikan izin kepada pengguna akhir untuk menggunakan produk tersebut. Anda dapat memperoleh ProductId dari respons operasi seperti UpdateProduct, LaunchProduct, CreateProduct, ListProductsAsAdmin, dan GetProductVersion.
Online debugging page
Anda dapat melakukan debugging operasi API pada halaman berikut: Daftar debugging API Service Catalog
Endpoints
Pilih titik akhir berdasarkan wilayah tempat sumber daya Anda berada untuk mengurangi latensi. Misalnya, jika Service Catalog Anda berada di wilayah China (Hangzhou), titik akhir publiknya adalah servicecatalog.cn-hangzhou.aliyuncs.com, dan titik akhir VPC-nya adalah servicecatalog-vpc.cn-hangzhou.aliyuncs.com.
Titik akhir publik dapat diakses secara global.
Titik akhir VPC hanya dapat diakses di dalam VPC pada wilayah Alibaba Cloud tertentu. Titik akhir VPC memberikan manfaat berikut:
Keamanan lebih tinggi: Titik akhir VPC hanya dapat diakses di dalam VPC, sehingga menawarkan keamanan dan privasi yang lebih baik.
Respons lebih cepat: Titik akhir VPC menggunakan lingkungan jaringan internal sehingga memberikan respons lebih cepat dibandingkan titik akhir publik. Selain itu, penggunaan titik akhir VPC menghindarkan Anda dari masalah seperti latensi jaringan dan batas bandwidth.
Biaya lebih rendah: Titik akhir VPC diakses melalui jaringan internal.
Untuk informasi selengkapnya, lihat Endpoints.
User identities
Setelah login ke OpenAPI Explorer menggunakan Akun Alibaba Cloud Anda, OpenAPI Explorer secara default menggunakan akun tersebut untuk debugging online. Akun Alibaba Cloud memiliki izin atas semua operasi API, sehingga penggunaannya untuk debugging API secara online dapat menimbulkan risiko keamanan. Kami menyarankan agar Anda memanggil operasi API atau melakukan operasi dan pemeliharaan (O&M) rutin sebagai Pengguna Resource Access Management (RAM). Sebelum memanggil operasi API sebagai Pengguna RAM, berikan izin yang diperlukan sesuai kebutuhan bisnis Anda. Pengguna RAM tersebut harus memiliki izin untuk mengelola Service Catalog. Untuk informasi selengkapnya, lihat Gunakan RAM untuk kontrol akses.
Identity | Supported |
Yes | |
Pengguna RAM (direkomendasikan) | Yes |
Peran RAM (direkomendasikan) | Yes |
References
Integration methods
SDK mudah diintegrasikan ke dalam aplikasi Anda dan mencakup cakupan operasi terluas. Kami menyarankan Anda menggunakan SDK untuk memanggil operasi API.
Overview of integration methods
Integration method | Supported |
Alibaba Cloud SDKs (direkomendasikan) | Yes |
No | |
No | |
Yes |
-
Alibaba Cloud SDKs
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 informasi seperti logika signature, mekanisme timeout, dan mekanisme retry, serta mengembalikan objek respons terstruktur berdasarkan spesifikasi, sehingga mempermudah pengembangan. Untuk informasi selengkapnya, lihat Alibaba Cloud SDKs.
-
Anda dapat menggunakan Alibaba Cloud SDK untuk memanggil operasi Service Catalog. Untuk informasi mengenai bahasa yang didukung dan cara menginstal dependensi, lihat Service Catalog SDK.
Alibaba Cloud CLI
Alibaba Cloud CLI memungkinkan Anda menjalankan perintah
aliyununtuk berinteraksi dengan layanan Alibaba Cloud dan mengelola sumber daya layanan cloud. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?Anda tidak dapat menggunakan Alibaba Cloud CLI untuk memanggil operasi API Service Catalog.
ROS
ROS adalah layanan Alibaba Cloud yang menyederhanakan pengelolaan sumber daya komputasi cloud. Anda dapat membuat templat untuk menggambarkan sumber daya komputasi cloud yang Anda butuhkan, seperti instans Elastic Compute Service (ECS) dan ApsaraDB RDS, serta hubungan antar sumber daya tersebut. ROS secara otomatis membuat dan mengonfigurasi semua sumber daya berdasarkan templat untuk menerapkan deployment dan O&M otomatis. Untuk informasi selengkapnya, lihat Apa itu ROS?
Anda tidak dapat menggunakan ROS untuk memanggil operasi API Service Catalog.
Custom encapsulation
Untuk melakukan panggilan HTTP native, Anda harus membuat permintaan kustom dan menandatangani permintaan tersebut. Untuk informasi selengkapnya mengenai metode signature, lihat Daftar operasi berdasarkan fungsi dan Sintaks permintaan dan metode signature V3.
Usage notes
Jika terjadi kesalahan setelah Anda memanggil operasi API, periksa apakah parameter permintaan dan nilai parameternya valid berdasarkan kode kesalahan tersebut.
Anda juga dapat mencatat RequestID dari respons atau pesan kesalahan SDK dan menggunakan halaman Diagnostik masalah OpenAPI untuk diagnostik mandiri.
References
Service Catalog adalah layanan Infrastructure as Code (IaC) yang dikembangkan oleh Alibaba Cloud. Service Catalog membantu perusahaan mengonfigurasi layanan yang memenuhi persyaratan tertentu dan menetapkan batasan peluncuran layanan. Dengan demikian, perusahaan dapat memilih layanan berdasarkan kebutuhan bisnis mereka secara praktis saat memigrasikan beban kerja ke cloud, sehingga meningkatkan efisiensi pengiriman layanan TI. Untuk informasi selengkapnya, lihat Apa itu Service Catalog?
Untuk informasi selengkapnya mengenai bahasa pemrograman yang didukung oleh SDK Service Catalog, lihat Ikhtisar SDK.