Este tópico descreve os estilos RPC e ROA do OpenAPI. Para fazer uma solicitação personalizada, é necessário conhecer o estilo da API do serviço a ser chamado. O estilo da API define a estrutura do método HTTP, do cabeçalho da solicitação, da string de consulta e do corpo da solicitação.
Os serviços da Alibaba Cloud usam dois estilos de OpenAPI: RPC e ROA.
Estilo RPC
Remote Procedure Call (RPC) é um protocolo que permite a um programa chamar uma função ou método em outro programa como se fosse uma chamada local.
Em uma API de estilo RPC, o cliente se comunica com o servidor por meio de chamadas de função ou método, em vez de manipular recursos diretamente.
As APIs de estilo RPC suportam os métodos HTTP GET e POST.
O OpenAPI aplica-se a produtos de estilo RPC, como Elastic Compute Service (ECS), ApsaraDB RDS e Content Delivery Network (CDN).
Exemplo:
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) é um estilo arquitetural para projetar serviços web. Uma API RESTful permite que um aplicativo cliente interaja com um servidor por meio de solicitações HTTP. Ela usa métodos como GET, POST, PUT e DELETE para executar operações de criação, leitura, atualização e exclusão (CRUD).
Resource-Oriented Architecture (ROA) é um estilo arquitetural orientado a recursos e uma extensão do REST.
As APIs de estilo ROA suportam os seguintes métodos HTTP:
GET: recupera um recurso do servidor. Este método não modifica o estado dos recursos no servidor.
POST: envia dados ao servidor para criar um novo recurso ou executar uma ação específica.
PUT: atualiza um recurso no servidor. O cliente deve fornecer os dados completos do recurso.
DELETE: exclui um recurso do servidor.
O OpenAPI aplica-se a produtos de estilo ROA, como Application Real-Time Monitoring Service (ARMS), Batch Compute, Container Service for Kubernetes (ACK) e 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"
}Verificar o estilo da API
Acesse a seção API Reference na documentação de um produto de nuvem no Centro de Ajuda e visualize o documento API Overview. Esse documento descreve o estilo de API usado pelo OpenAPI. Por exemplo, para visualizar o documento Visão geral da API do Elastic Compute Service (ECS), selecione Developer Guide > API Reference (ECS) > API Overview no painel de navegação à esquerda do Centro de Ajuda da Alibaba Cloud. A página exibe a descrição do estilo de assinatura: o OpenAPI deste produto (Elastic Compute Service ECS/2014-05-26) usa o estilo de assinatura RPC.