Topik ini menjelaskan gaya Remote Procedure Call (RPC) dan Resource-Oriented Architecture (ROA) untuk OpenAPI. Sebelum membuat permintaan kustom, Anda harus mengetahui gaya API dari produk yang ingin dipanggil. Gaya API tersebut menentukan cara mengonfigurasi metode permintaan, header permintaan, string kueri, dan badan permintaan.
Produk Alibaba Cloud terutama menggunakan dua gaya untuk mendefinisikan 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 memanggil fungsi lokal.
Pada API bergaya RPC, komunikasi antara klien dan server berdasarkan pemanggilan fungsi atau metode, bukan sumber daya. Saat klien mengirim permintaan ke server, parameter fungsi atau metode dikirimkan, bukan pengidentifikasi sumber daya. Setelah menerima permintaan tersebut, server mengeksekusi fungsi atau metode yang ditentukan dan mengembalikan hasilnya kepada klien.
API bergaya RPC mendukung metode GET dan POST.
Produk Alibaba Cloud yang menggunakan gaya RPC untuk OpenAPI meliputi 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 dan menggunakan metode HTTP—seperti GET, POST, PUT, dan DELETE—untuk melakukan operasi Create, Read, Update, dan Delete (CRUD).
Resource-Oriented Architecture (ROA) adalah gaya arsitektur berbasis sumber daya yang merupakan perluasan dari REST.
API bergaya ROA mendukung metode berikut:
GET: Mengambil sumber daya dari server. Metode ini biasanya tidak mengubah sumber daya di server.
POST: Mengirim data ke server untuk membuat sumber daya baru atau menjalankan suatu operasi.
PUT: Memperbarui sumber daya di server. Saat mengirim permintaan PUT, Anda harus menyediakan data sumber daya secara lengkap.
DELETE: Menghapus sumber daya dari server.
Produk Alibaba Cloud yang menggunakan gaya ROA untuk OpenAPI meliputi Application Real-Time Monitoring Service (ARMS), Batch Compute, Container Service, 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"
}Cara melihat
Buka bagian API Reference dalam dokumentasi produk di Pusat Bantuan. Klik dokumen API Overview untuk menemukan gaya OpenAPI yang digunakan oleh produk tersebut. Misalnya, lihat ikhtisar API untuk Elastic Compute Service (ECS).