Este tema describe los estilos RPC y ROA para openapi. Para enviar una solicitud personalizada, debe conocer el estilo de API del servicio que desea invocar. El estilo de la API determina cómo se estructura el método HTTP, el encabezado de la solicitud, la cadena de consulta y el cuerpo de la solicitud.
Los servicios de Alibaba Cloud utilizan dos estilos de openapi: RPC y ROA.
Estilo RPC
Remote Procedure Call (RPC) es un protocolo que permite a un programa invocar una función o un método en otro programa como si fuera una llamada local.
En una API con estilo RPC, un cliente se comunica con un servidor mediante llamadas a funciones o métodos, no mediante la manipulación de recursos.
Las API con estilo RPC admiten los métodos HTTP GET y POST.
openapi está diseñado para productos con estilo RPC, como Elastic Compute Service (ECS), ApsaraDB RDS y Content Delivery Network (CDN).
Por ejemplo:
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
Estilo ROA
Representational State Transfer (REST) es un estilo arquitectónico para diseñar servicios web. Una API RESTful permite que una aplicación cliente interactúe con un servidor mediante solicitudes HTTP, utilizando métodos HTTP como GET, POST, PUT y DELETE para ejecutar operaciones de creación, lectura, actualización y eliminación (CRUD).
Resource-Oriented Architecture (ROA) es un estilo arquitectónico basado en recursos y una extensión de REST.
Las API con estilo ROA admiten los siguientes métodos HTTP:
GET: recupera un recurso del servidor. Este método no modifica el estado de los recursos en el servidor.
POST: envía datos al servidor para crear un nuevo recurso o ejecutar una acción específica.
PUT: actualiza un recurso en el servidor. El cliente debe proporcionar los datos completos del recurso.
DELETE: elimina un recurso del servidor.
openapi se utiliza para productos con estilo ROA, como Application Real-Time Monitoring Service (ARMS), Batch Compute, Container Service for Kubernetes (ACK) y 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"
}Comprobar el estilo de la API
Vaya a la sección API Reference de la documentación de un producto en la nube dentro del Centro de ayuda y consulte el documento API Overview, que describe el estilo de API que utiliza openapi. Por ejemplo, para consultar el documento API Overview de Elastic Compute Service (ECS), seleccione Developer Guide > API Reference (ECS) > API Overview en la barra de navegación izquierda del Centro de ayuda de Alibaba Cloud. La página proporciona una descripción del estilo de firma: The openapi for this product (Elastic Compute Service ECS/2014-05-26) uses the RPC signature style.