Topik ini menjelaskan gaya RPC dan ROA dalam OpenAPI. Untuk membuat permintaan kustom, Anda harus mengetahui gaya API dari layanan yang ingin dipanggil. Gaya API tersebut menentukan cara menyusun metode HTTP, header permintaan, string kueri, dan badan permintaan.
Layanan Alibaba Cloud menggunakan dua gaya OpenAPI: RPC dan ROA.
Gaya RPC
Remote Procedure Call (RPC) adalah protokol yang memungkinkan suatu program memanggil fungsi atau metode di program lain seolah-olah merupakan panggilan lokal.
Pada API bergaya RPC, klien berkomunikasi dengan server melalui pemanggilan fungsi atau metode, bukan dengan memanipulasi resource.
API bergaya RPC mendukung metode HTTP GET dan POST.
OpenAPI digunakan untuk produk bergaya RPC, seperti Elastic Compute Service (ECS), ApsaraDB RDS, dan Content Delivery Network (CDN).
Contoh:
http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeDedicatedHosts&Format=XML&SignatureNonce=3ee8c1b8-xxxx-xxxx-xxxx-xxxxxxxxx&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%3A46%3A24Z&RegionId=cn-hangzhou&Status=Available
Gaya ROA
Representational State Transfer (REST) adalah gaya arsitektur untuk merancang layanan web. API RESTful memungkinkan aplikasi klien berinteraksi dengan server melalui permintaan HTTP, menggunakan metode HTTP seperti GET, POST, PUT, dan DELETE untuk melakukan operasi Membuat, Membaca, Memperbarui, dan Menghapus (CRUD).
Resource-Oriented Architecture (ROA) adalah gaya arsitektur berbasis resource dan merupakan perluasan dari REST.
API bergaya ROA mendukung metode HTTP berikut:
-
GET: Mengambil resource dari server. Metode ini tidak mengubah status resource di server.
-
POST: Mengirim data ke server untuk membuat resource baru atau menjalankan aksi tertentu.
-
PUT: Memperbarui resource di server. Klien harus menyediakan data lengkap untuk resource tersebut.
-
DELETE: Menghapus resource dari server.
OpenAPI digunakan untuk produk bergaya ROA seperti Application Real-Time Monitoring Service (ARMS), Batch Compute, Container Service for Kubernetes (ACK), dan Elasticsearch.
POST /clusters/test_cluster_id/triggers HTTP/1.1
{
"x-acs-action":"CreateTrigger",
"x-acs-version":"2015-12-15",
"Accept":"application/json",
"Authorization": "acs testid:D9uFJAJgLL+dryjBfQK+YeqGtoY=",
"x-acs-signature-nonce":"15215528852396",
"Date":"Tue 9 Apr 2022 07:35:29 GMT",
"x-acs-signature-method":"HMAC-SHA1",
"Content-MD5":"Gtl/0jNYHf8t9Lq8Xlpaqw=="
"Host":"cs.aliyuncs.com"
}
{
"cluster_id":"test_cluster_id",
"project_id":"default/nginx-test",
"action":"redeploy",
"type":"deployment"
}Periksa gaya API
Buka bagian API Reference dalam dokumentasi produk cloud di Help Center, lalu lihat dokumen API Overview yang menjelaskan gaya API yang digunakan oleh OpenAPI. Sebagai contoh, untuk melihat dokumen API Overview untuk Elastic Compute Service (ECS), pilih Developer Guide > API Reference (ECS) > API Overview di bilah navigasi kiri Alibaba Cloud Help Center. Halaman tersebut menjelaskan bahwa gaya signature OpenAPI untuk produk ini (Elastic Compute Service ECS/2014-05-26) menggunakan gaya signature RPC.